Trait gdnative::prelude::ToVariant

pub trait ToVariant {
    fn to_variant(&self) -> Variant;
}

Types that can be converted to a Variant.

Wrappers and collections

Implementations are provided for a few common Rust wrappers and collections:

• Option<T> is unwrapped to inner value, or Nil if None
• Result<T, E> is represented as an externally tagged Dictionary (see below).
• PhantomData<T> is represented as Nil.
• &[T] and Vec<T> are represented as VariantArrays. FromVariant is only implemented for Vec<T>.

Deriving ToVariant

The derive macro does the following mapping between Rust structures and Godot types:

• Newtype(inner) is unwrapped to inner
• Tuple(a, b, c) is represented as a VariantArray ([a, b, c])
• Struct { a, b, c } is represented as a Dictionary ({ "a": a, "b": b, "c": c })
• Unit is represented as an empty Dictionary ({})
• Enum::Variant(a, b, c) is represented as an externally tagged Dictionary ({ "Variant": [a, b, c] })

Behavior of the derive macros can be customized using attributes:

Field attributes

• #[variant(to_variant_with = "path::to::func")]

Use the given function to convert the field to Variant. The function's signature is expected to be fn(&T) -> Variant, although it can be generic over T.

• #[variant(from_variant_with = "path::to::func")]

Use the given function to convert from a Variant. The function's signature is expected to be fn(&Variant) -> Result<T, FromVariantError>, although it can be generic over T.

• #[variant(with = "path::to::mod")]

Convenience attribute that sets to_variant_with to path::to::mod::to_variant and from_variant_with to path::to::mod::from_variant.

• #[variant(skip_to_variant)]

Skip the field when converting to Variant.

• #[variant(skip_from_variant)]

Skip the field when converting from Variant. A default vale will be obtained using Default::default().

• #[variant(skip)]

Convenience attribute that sets skip_to_variant and skip_from_variant.

Required methods

fn to_variant(&self) -> Variant

Loading content...

Implementations on Foreign Types

impl<T> ToVariant for PhantomData<T>

fn to_variant(&self) -> Variant

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

fn to_variant(&self) -> Variant

impl ToVariant for str

fn to_variant(&self) -> Variant

impl ToVariant for f32

fn to_variant(&self) -> Variant

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

fn to_variant(&self) -> Variant

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

fn to_variant(&self) -> Variant

impl ToVariant for f64

fn to_variant(&self) -> Variant

impl ToVariant for isize

fn to_variant(&self) -> Variant

impl ToVariant for i64

fn to_variant(&self) -> Variant

impl<'a, T> ToVariant for &'a T where
    T: ToVariant + ?Sized, 

fn to_variant(&self) -> Variant

impl ToVariant for Transform2D<f32, UnknownUnit, UnknownUnit>

fn to_variant(&self) -> Variant

impl<'_, T> ToVariant for &'_ [T] where
    T: ToVariant, 

fn to_variant(&self) -> Variant

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

fn to_variant(&self) -> Variant

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

fn to_variant(&self) -> Variant

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

fn to_variant(&self) -> Variant

impl ToVariant for Vector3D<f32, UnknownUnit>

fn to_variant(&self) -> Variant

impl ToVariant for u16

fn to_variant(&self) -> Variant

impl ToVariant for u8

fn to_variant(&self) -> Variant

impl ToVariant for Rect<f32, UnknownUnit>

fn to_variant(&self) -> Variant

impl ToVariant for i16

fn to_variant(&self) -> Variant

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

fn to_variant(&self) -> Variant

impl<T> ToVariant for Vec<T> where
    T: ToVariant, 

fn to_variant(&self) -> Variant

impl ToVariant for Rotation3D<f32, UnknownUnit, UnknownUnit>

fn to_variant(&self) -> Variant

impl ToVariant for i8

fn to_variant(&self) -> Variant

impl<'a, T> ToVariant for &'a mut T where
    T: ToVariant + ?Sized, 

fn to_variant(&self) -> Variant

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

fn to_variant(&self) -> Variant

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

fn to_variant(&self) -> Variant

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

fn to_variant(&self) -> Variant

impl ToVariant for ()

fn to_variant(&self) -> Variant

impl ToVariant for String

fn to_variant(&self) -> Variant

impl ToVariant for usize

fn to_variant(&self) -> Variant

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

fn to_variant(&self) -> Variant

impl ToVariant for u64

fn to_variant(&self) -> Variant

impl ToVariant for Vector2D<f32, UnknownUnit>

fn to_variant(&self) -> Variant

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

fn to_variant(&self) -> Variant

impl ToVariant for i32

fn to_variant(&self) -> Variant

impl ToVariant for bool

fn to_variant(&self) -> Variant

impl ToVariant for u32

fn to_variant(&self) -> Variant

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

fn to_variant(&self) -> Variant

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

fn to_variant(&self) -> Variant

Loading content...

Implementors

impl ToVariant for Aabb

fn to_variant(&self) -> Variant

impl ToVariant for Basis

fn to_variant(&self) -> Variant

impl ToVariant for Color

fn to_variant(&self) -> Variant

impl ToVariant for Dictionary<Shared>

fn to_variant(&self) -> Variant

impl ToVariant for GodotString

fn to_variant(&self) -> Variant

impl ToVariant for NodePath

fn to_variant(&self) -> Variant

impl ToVariant for Plane

fn to_variant(&self) -> Variant

impl ToVariant for Rid

fn to_variant(&self) -> Variant

impl ToVariant for Transform

fn to_variant(&self) -> Variant

impl ToVariant for Variant

fn to_variant(&self) -> Variant

impl ToVariant for VariantArray<Shared>

fn to_variant(&self) -> Variant

impl<'a, T> ToVariant for TRef<'a, T, Shared> where
    T: GodotObject, 

fn to_variant(&self) -> Variant

impl<T> ToVariant for Ref<T, Shared> where
    T: GodotObject, 

fn to_variant(&self) -> Variant

impl<T> ToVariant for TypedArray<T> where
    T: Element, 

fn to_variant(&self) -> Variant

impl<T, Access> ToVariant for Instance<T, Access> where
    Access: ThreadAccess,
    T: NativeClass,
    Ref<<T as NativeClass>::Base, Access>: ToVariant, 

fn to_variant(&self) -> Variant

Loading content...