Trait gdnative::core_types::FromVariant

source ·

pub trait FromVariant: Sized {
    fn from_variant(variant: &Variant) -> Result<Self, FromVariantError>;
}

Expand description

Types that can be converted from a Variant. Conversions are performed in Rust, and can be implemented for custom types.

FromVariant generally avoids inexact conversions, favoring returning an error instead, with the noted exception of integer and float types that are not supported by Godot natively. This is stricter than what GDScript performs by default. For weakly-typed coercions of GDScript built-in typed, see CoerceFromVariant instead.

This trait is used for argument types of exported methods.

`Option<T>` and `MaybeNot<T>`

Option<T> requires the Variant to be T or Nil, in that order. For looser semantics, use MaybeNot<T>, which will catch all variant values that are not T as well.

`Vec<T>`

The FromVariant implementation for Vec<T> only allow homogeneous arrays. If you want to manually handle potentially heterogeneous values e.g. for error reporting, use VariantArray directly or compose with an appropriate wrapper: Vec<Option<T>> or Vec<MaybeNot<T>>.

Deriving `FromVariant`

The derive macro provides implementation consistent with derived ToVariant. See ToVariant for detailed documentation.

Trait gdnative::core_types::FromVariant

Required Methods§

fn from_variant(variant: &Variant) -> Result<Self, FromVariantError>

Implementations on Foreign Types§

impl<T12> FromVariant for (T12,)where T12: FromVariant,

fn from_variant(v: &Variant) -> Result<(T12,), FromVariantError>

impl FromVariant for f32

fn from_variant(variant: &Variant) -> Result<f32, FromVariantError>

impl<K, V> FromVariant for HashMap<K, V, RandomState>where K: FromVariant + Hash + Eq, V: FromVariant,

fn from_variant( variant: &Variant) -> Result<HashMap<K, V, RandomState>, FromVariantError>

impl FromVariant for isize

fn from_variant(variant: &Variant) -> Result<isize, FromVariantError>

impl FromVariant for i64

fn from_variant(variant: &Variant) -> Result<i64, FromVariantError>

impl<T> FromVariant for Vec<T, Global>where T: FromVariant,

fn from_variant(variant: &Variant) -> Result<Vec<T, Global>, FromVariantError>

impl FromVariant for ()

fn from_variant(variant: &Variant) -> Result<(), FromVariantError>

impl<T4, T5, T6, T7, T8, T9, T10, T11, T12> FromVariant for (T4, T5, T6, T7, T8, T9, T10, T11, T12)where T4: FromVariant, T5: FromVariant, T6: FromVariant, T7: FromVariant, T8: FromVariant, T9: FromVariant, T10: FromVariant, T11: FromVariant, T12: FromVariant,

fn from_variant( v: &Variant) -> Result<(T4, T5, T6, T7, T8, T9, T10, T11, T12), FromVariantError>

impl FromVariant for usize

fn from_variant(variant: &Variant) -> Result<usize, FromVariantError>

impl<T5, T6, T7, T8, T9, T10, T11, T12> FromVariant for (T5, T6, T7, T8, T9, T10, T11, T12)where T5: FromVariant, T6: FromVariant, T7: FromVariant, T8: FromVariant, T9: FromVariant, T10: FromVariant, T11: FromVariant, T12: FromVariant,

fn from_variant( v: &Variant) -> Result<(T5, T6, T7, T8, T9, T10, T11, T12), FromVariantError>

impl FromVariant for u64

fn from_variant(variant: &Variant) -> Result<u64, FromVariantError>

impl FromVariant for i32

fn from_variant(variant: &Variant) -> Result<i32, FromVariantError>

impl FromVariant for i16

fn from_variant(variant: &Variant) -> Result<i16, FromVariantError>

fn from_variant( v: &Variant) -> Result<(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12), FromVariantError>

impl FromVariant for u16

fn from_variant(variant: &Variant) -> Result<u16, FromVariantError>

impl FromVariant for bool

fn from_variant(variant: &Variant) -> Result<bool, FromVariantError>

impl<T3, T4, T5, T6, T7, T8, T9, T10, T11, T12> FromVariant for (T3, T4, T5, T6, T7, T8, T9, T10, T11, T12)where T3: FromVariant, T4: FromVariant, T5: FromVariant, T6: FromVariant, T7: FromVariant, T8: FromVariant, T9: FromVariant, T10: FromVariant, T11: FromVariant, T12: FromVariant,

fn from_variant( v: &Variant) -> Result<(T3, T4, T5, T6, T7, T8, T9, T10, T11, T12), FromVariantError>

impl FromVariant for u32

fn from_variant(variant: &Variant) -> Result<u32, FromVariantError>

impl FromVariant for u8

fn from_variant(variant: &Variant) -> Result<u8, FromVariantError>

fn from_variant( v: &Variant) -> Result<(T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12), FromVariantError>

impl<T> FromVariant for HashSet<T, RandomState>where T: FromVariant + Eq + Hash,

fn from_variant( variant: &Variant) -> Result<HashSet<T, RandomState>, FromVariantError>

impl<T> FromVariant for PhantomData<T>

fn from_variant(variant: &Variant) -> Result<PhantomData<T>, FromVariantError>

impl<T> FromVariant for Option<T>where T: FromVariant,

fn from_variant(variant: &Variant) -> Result<Option<T>, FromVariantError>

impl<T7, T8, T9, T10, T11, T12> FromVariant for (T7, T8, T9, T10, T11, T12)where T7: FromVariant, T8: FromVariant, T9: FromVariant, T10: FromVariant, T11: FromVariant, T12: FromVariant,

fn from_variant( v: &Variant) -> Result<(T7, T8, T9, T10, T11, T12), FromVariantError>

impl<T10, T11, T12> FromVariant for (T10, T11, T12)where T10: FromVariant, T11: FromVariant, T12: FromVariant,

fn from_variant(v: &Variant) -> Result<(T10, T11, T12), FromVariantError>

impl FromVariant for i8

fn from_variant(variant: &Variant) -> Result<i8, FromVariantError>

impl FromVariant for f64

fn from_variant(variant: &Variant) -> Result<f64, FromVariantError>

impl<T, E> FromVariant for Result<T, E>where T: FromVariant, E: FromVariant,

fn from_variant(variant: &Variant) -> Result<Result<T, E>, FromVariantError>

impl<T8, T9, T10, T11, T12> FromVariant for (T8, T9, T10, T11, T12)where T8: FromVariant, T9: FromVariant, T10: FromVariant, T11: FromVariant, T12: FromVariant,

fn from_variant( v: &Variant) -> Result<(T8, T9, T10, T11, T12), FromVariantError>

impl<T6, T7, T8, T9, T10, T11, T12> FromVariant for (T6, T7, T8, T9, T10, T11, T12)where T6: FromVariant, T7: FromVariant, T8: FromVariant, T9: FromVariant, T10: FromVariant, T11: FromVariant, T12: FromVariant,

fn from_variant( v: &Variant) -> Result<(T6, T7, T8, T9, T10, T11, T12), FromVariantError>

impl<T11, T12> FromVariant for (T11, T12)where T11: FromVariant, T12: FromVariant,

fn from_variant(v: &Variant) -> Result<(T11, T12), FromVariantError>

impl<T9, T10, T11, T12> FromVariant for (T9, T10, T11, T12)where T9: FromVariant, T10: FromVariant, T11: FromVariant, T12: FromVariant,

fn from_variant(v: &Variant) -> Result<(T9, T10, T11, T12), FromVariantError>

impl FromVariant for String

fn from_variant(variant: &Variant) -> Result<String, FromVariantError>

Implementors§

impl FromVariant for gdnative::api::aes_context::Mode

impl FromVariant for InterpolationType

impl FromVariant for TrackType

impl FromVariant for gdnative::api::animation::UpdateMode

impl FromVariant for FilterAction

impl FromVariant for gdnative::api::animation_node_blend_space_2d::BlendMode

impl FromVariant for MixMode

impl FromVariant for SwitchMode

impl FromVariant for AnimationMethodCallMode

impl FromVariant for gdnative::api::animation_player::AnimationProcessMode

impl FromVariant for gdnative::api::animation_tree::AnimationProcessMode

impl<T12> FromVariant for (T12,)where
T12: FromVariant,

impl<K, V> FromVariant for HashMap<K, V, RandomState>where
K: FromVariant + Hash + Eq,
V: FromVariant,

fn from_variant(
variant: &Variant
) -> Result<HashMap<K, V, RandomState>, FromVariantError>

impl<T> FromVariant for Vec<T, Global>where
T: FromVariant,

impl<T4, T5, T6, T7, T8, T9, T10, T11, T12> FromVariant for (T4, T5, T6, T7, T8, T9, T10, T11, T12)where
T4: FromVariant,
T5: FromVariant,
T6: FromVariant,
T7: FromVariant,
T8: FromVariant,
T9: FromVariant,
T10: FromVariant,
T11: FromVariant,
T12: FromVariant,

fn from_variant(
v: &Variant
) -> Result<(T4, T5, T6, T7, T8, T9, T10, T11, T12), FromVariantError>

impl<T5, T6, T7, T8, T9, T10, T11, T12> FromVariant for (T5, T6, T7, T8, T9, T10, T11, T12)where
T5: FromVariant,
T6: FromVariant,
T7: FromVariant,
T8: FromVariant,
T9: FromVariant,
T10: FromVariant,
T11: FromVariant,
T12: FromVariant,

fn from_variant(
v: &Variant
) -> Result<(T5, T6, T7, T8, T9, T10, T11, T12), FromVariantError>

fn from_variant(
v: &Variant
) -> Result<(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12), FromVariantError>

impl<T3, T4, T5, T6, T7, T8, T9, T10, T11, T12> FromVariant for (T3, T4, T5, T6, T7, T8, T9, T10, T11, T12)where
T3: FromVariant,
T4: FromVariant,
T5: FromVariant,
T6: FromVariant,
T7: FromVariant,
T8: FromVariant,
T9: FromVariant,
T10: FromVariant,
T11: FromVariant,
T12: FromVariant,

fn from_variant(
v: &Variant
) -> Result<(T3, T4, T5, T6, T7, T8, T9, T10, T11, T12), FromVariantError>

fn from_variant(
v: &Variant
) -> Result<(T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12), FromVariantError>

impl<T> FromVariant for HashSet<T, RandomState>where
T: FromVariant + Eq + Hash,

fn from_variant(
variant: &Variant
) -> Result<HashSet<T, RandomState>, FromVariantError>

impl<T> FromVariant for Option<T>where
T: FromVariant,

impl<T7, T8, T9, T10, T11, T12> FromVariant for (T7, T8, T9, T10, T11, T12)where
T7: FromVariant,
T8: FromVariant,
T9: FromVariant,
T10: FromVariant,
T11: FromVariant,
T12: FromVariant,

fn from_variant(
v: &Variant
) -> Result<(T7, T8, T9, T10, T11, T12), FromVariantError>

impl<T10, T11, T12> FromVariant for (T10, T11, T12)where
T10: FromVariant,
T11: FromVariant,
T12: FromVariant,

impl<T, E> FromVariant for Result<T, E>where
T: FromVariant,
E: FromVariant,

impl<T8, T9, T10, T11, T12> FromVariant for (T8, T9, T10, T11, T12)where
T8: FromVariant,
T9: FromVariant,
T10: FromVariant,
T11: FromVariant,
T12: FromVariant,

fn from_variant(
v: &Variant
) -> Result<(T8, T9, T10, T11, T12), FromVariantError>

impl<T6, T7, T8, T9, T10, T11, T12> FromVariant for (T6, T7, T8, T9, T10, T11, T12)where
T6: FromVariant,
T7: FromVariant,
T8: FromVariant,
T9: FromVariant,
T10: FromVariant,
T11: FromVariant,
T12: FromVariant,

fn from_variant(
v: &Variant
) -> Result<(T6, T7, T8, T9, T10, T11, T12), FromVariantError>

impl<T11, T12> FromVariant for (T11, T12)where
T11: FromVariant,
T12: FromVariant,

impl<T9, T10, T11, T12> FromVariant for (T9, T10, T11, T12)where
T9: FromVariant,
T10: FromVariant,
T11: FromVariant,
T12: FromVariant,