Enum gdnative::core_types::FromVariantError

#[non_exhaustive]
pub enum FromVariantError {
    Unspecified,
    Custom(String),
    InvalidNil,
    InvalidVariantType {
        variant_type: VariantType,
        expected: VariantType,
    },
    CannotCast {
        class: String,
        to: &'static str,
    },
    InvalidLength {
        len: usize,
        expected: usize,
    },
    InvalidEnumRepr {
        expected: VariantEnumRepr,
        error: Box<FromVariantError>,
    },
    InvalidStructRepr {
        expected: VariantStructRepr,
        error: Box<FromVariantError>,
    },
    UnknownEnumVariant {
        variant: String,
        expected: &'static [&'static str],
    },
    InvalidEnumVariant {
        variant: &'static str,
        error: Box<FromVariantError>,
    },
    InvalidInstance {
        expected: Cow<'static, str>,
    },
    InvalidField {
        field_name: &'static str,
        error: Box<FromVariantError>,
    },
    InvalidItem {
        index: usize,
        error: Box<FromVariantError>,
    },
}

Error type returned by FromVariant::from_variant.

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.

Unspecified

An unspecified error.

Custom(String)

A custom error message.

InvalidNil

Null value given for a non-nullable type, with no further information given.

InvalidVariantType

Variant type is different from the expected one.

Fields

variant_type: VariantType

expected: VariantType

CannotCast

Cannot cast the object to the given Godot class.

Fields

class: String

to: &'static str

InvalidLength

Length of the collection is different from the expected one.

Fields

len: usize

expected: usize

InvalidEnumRepr

Invalid enum representation.

Fields

expected: VariantEnumRepr

error: Box<FromVariantError>

InvalidStructRepr

Invalid struct representation.

Fields

expected: VariantStructRepr

error: Box<FromVariantError>

UnknownEnumVariant

Error indicating that the implementation encountered an enum variant that does not exist at compile time.

For example, trying to create a Result<T, E> from { "Foo": "Bar" } will result in this error, since Foo is not a valid variant of Result.

Fields

variant: String

Name of the unknown variant

expected: &'static [&'static str]

Names of all expected variants known at compile time

InvalidEnumVariant

Error indicating that the implementation encountered a known enum variant, but the value is invalid for the definition.

This could result from multiple underlying reasons, detailed in the error field:

• Missing fields.
• Unexpected representation, e.g. { "0": "foo", "1": "bar" } for a tuple.
• Error in a nested field.

Fields

variant: &'static str

error: Box<FromVariantError>

InvalidInstance

Given object is not an instance of the expected NativeClass.

Fields

expected: Cow<'static, str>

InvalidField

Collection contains an invalid field.

Fields

field_name: &'static str

error: Box<FromVariantError>

InvalidItem

Collection contains an invalid item.

Fields

index: usize

error: Box<FromVariantError>

Implementations

impl FromVariantError

pub fn custom<T>(message: T) -> FromVariantError

where T: Display,

Returns a FromVariantError with a custom message.

Trait Implementations

impl Clone for FromVariantError

fn clone(&self) -> FromVariantError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FromVariantError

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

Formats the value using the given formatter.

impl Display for FromVariantError

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

Formats the value using the given formatter.

impl Error for FromVariantError

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 PartialEq for FromVariantError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for FromVariantError

impl StructuralPartialEq for FromVariantError