Enum ComponentError 

#[non_exhaustive]
pub enum ComponentError {
    Unknown {
        name: String,
        known: Vec<&'static str>,
    },
    Missing {
        entity: Entity,
        component: &'static str,
        source: EntityAccessError,
    },
    Allocate(AllocError),
    Reflect(ReflectError),
    Materialize(ShapeMismatchError),
    Encode {
        component: &'static str,
        source: SerializeError<JsonSerializeError>,
    },
    Decode {
        component: &'static str,
        source: Box<DeserializeError>,
    },
}

Available on crate feature reflect only.

Why the registry could not address a component.

A lookup fails for its own reason – an unknown name, a handle the scope cannot reach, a value that will not fit its shape – so each case keeps the handle, the component name and the underlying error rather than flattening them into one line of text.

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.

Unknown

No submitted entry answers to this name.

Fields

name: String

The name that was looked up.

known: Vec<&'static str>

The bare names that are submitted.

Missing

The entity does not carry the component, or this scope cannot reach it.

Fields

entity: Entity

The handle that was looked up.

component: &'static str

The component that was asked for.

source: EntityAccessError

Why the lookup was refused: a dead handle, one out of the scope’s reach, or one whose archetype lacks the component.

Allocate(AllocError)

The reflection could not lay out a value for the component.

Reflect(ReflectError)

A partial value was navigated or built wrongly.

Materialize(ShapeMismatchError)

The built value was not the component it was built as.

Encode

The component could not be written as JSON.

Fields

component: &'static str

The component that was asked for.

source: SerializeError<JsonSerializeError>

Why the serializer gave up.

Decode

The text could not be read into the component.

Fields

component: &'static str

The component that was asked for.

source: Box<DeserializeError>

Where in the text the read gave up, and why. Boxed: the deserializer error is large enough that every result carrying one would grow with it.

Trait Implementations

impl Debug for ComponentError

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

Formats the value using the given formatter.

impl Display for ComponentError

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

Formats the value using the given formatter.

impl Error for ComponentError

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<AllocError> for ComponentError

fn from(source: AllocError) -> Self

Converts to this type from the input type.

impl From<ReflectError> for ComponentError

fn from(source: ReflectError) -> Self

Converts to this type from the input type.

impl From<ShapeMismatchError> for ComponentError

fn from(source: ShapeMismatchError) -> Self

Converts to this type from the input type.