Enum EntityAccessError 

#[non_exhaustive]
pub enum EntityAccessError {
    NotAlive {
        entity: Entity,
    },
    NotVisible {
        entity: Entity,
        scope: Entity,
    },
    NotMatched {
        entity: Entity,
    },
    NotReserved {
        entity: Entity,
    },
    NotOwned {
        entity: Entity,
        scope: Entity,
    },
    NotMovable {
        entity: Entity,
        scope: Entity,
    },
    Scaffolding {
        entity: Entity,
    },
    WouldCycle {
        child: Entity,
        parent: Entity,
    },
    Archetype(ArchetypeAccessError),
}

Why a lookup of, or through, an entity handle was turned down.

The handle is carried by every variant, so a caller that reports the error does not have to thread it alongside.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

NotAlive

No live entity has this handle: it was despawned, or it never named one.

Fields

entity: Entity

The handle that was looked up.

NotVisible

The entity is alive, but out of this scope’s reach.

Fields

entity: Entity

The handle that was looked up.

scope: Entity

The scope it was looked up from.

NotMatched

The entity is visible here, but its archetype does not satisfy the query it was looked up with.

Fields

entity: Entity

The handle that was looked up.

NotReserved

The handle was not reserved, so there is no row to spawn on.

A handle from crate::World::reserve_entity can be spawned on once. Spawning on it again, on a handle that was released, or on one that was never reserved would leave a row nobody can reach or free.

Fields

entity: Entity

The handle that was spawned on.

NotOwned

The entity is alive, but this scope’s subtree does not reach it, so it is not the scope’s to remove or move.

Despawning and relinking walk the subtree, so what a scope cannot reach from inside it is also not its to change. The scope that owns the entity

• the root, for anything beside this one - is the one to ask.

Fields

entity: Entity

The handle that was moved or removed.

scope: Entity

The scope that tried.

NotMovable

The entity is visible here, but only the root may move or remove it.

The shared subtree is readable from every scope and rearrangeable by none but the root: a scope that reads a resource there is a borrower, not an owner.

Fields

entity: Entity

The handle that was moved or removed.

scope: Entity

The scope that tried.

Scaffolding

The entity is one of the tree’s two scaffolding entities.

The root and the shared scope are what the tree hangs from: they are neither counted nor queried, and they do not move or go.

Fields

entity: Entity

The handle that was moved or removed.

WouldCycle

Moving child under parent would put a scope inside its own subtree, which would cut the tree in two.

Fields

child: Entity

The handle that would have moved.

parent: Entity

The parent it would have moved under.

Archetype(ArchetypeAccessError)

The entity’s archetype could not be reached.

Trait Implementations

impl Clone for EntityAccessError

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for EntityAccessError

impl Debug for EntityAccessError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for EntityAccessError

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for EntityAccessError

impl Error for EntityAccessError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<ArchetypeAccessError> for EntityAccessError

fn from(source: ArchetypeAccessError) -> Self

Converts to this type from the input type.

impl PartialEq for EntityAccessError

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for EntityAccessError