Struct Variant

pub struct Variant<T> { /* private fields */ }

Union container for manipulating an object from a heterogeneous set of types in a uniform manner.

Implementations

impl<T> Variant<T>

pub const fn as_ptr(&self) -> *mut VariantWrapper

impl<T> Variant<T>

pub fn get_type(&self) -> Result<VariantDataType, Error>

Gets the data type of a Variant.

impl Variant<()>

pub fn cast<T>(self) -> Result<Option<Variant<T>>, Error>

where T: VariantConstraint,

Casts a generic Variant to a more specific type.

pub fn cast_ref<T>(&self) -> Result<Option<&Variant<T>>, Error>

where T: VariantConstraint,

Casts a generic Variant reference to a more specific type.

pub unsafe fn cast_unchecked<T>(self) -> Variant<T>

where T: VariantConstraint,

Casts a generic Variant to a more specific type.

Safety

The caller must ensure that T matches the type stored in the Variant.

pub unsafe fn cast_ref_unchecked<T>(&self) -> &Variant<T>

where T: VariantConstraint,

Casts a generic Variant reference to a more specific type.

Safety

The caller must ensure that T matches the type stored in the Variant.

impl<T> Variant<T>

where T: VariantConstraint,

pub fn create( domain: &Domain, value: <T as VariantConstraint>::DataArg<'_>, ) -> Result<Variant<T>, Error>

Creates a new Variant.

Arguments

• value - The initial value to store in the Variant.

pub fn get(&self) -> Result<<T as VariantConstraint>::RetArg, Error>

Returns the value stored in the Variant.

pub fn as_abstract(&self) -> &Variant<()>

Casts a Variant reference to its abstract representation.

pub fn to_abstract(self) -> Variant<()>

Casts a Variant to its abstract representation. Useful for returning a typed Variant in callbacks that expect a generic Variant.

Trait Implementations

impl Debug for Variant<()>

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

Formats the value using the given formatter.

impl<T> Debug for Variant<T>

where T: VariantConstraint,

let variant = Variant::<Vector2>::create(
    &domain,
    Vector2::ONE,
)?;
assert_eq!(
    format!("{variant:?}"),
    "Variant: vector2 = 'Vector2 { data: [1.0, 1.0] }'",
);

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

Formats the value using the given formatter.

impl Display for Variant<()>

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

Formats the value using the given formatter.

impl<T> Display for Variant<T>

where T: VariantConstraint,

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

Formats the value using the given formatter.

impl<T> Drop for Variant<T>

fn drop(&mut self)

Executes the destructor for this type.