Struct Variant

#[non_exhaustive]
#[repr(C)]
pub struct Variant<'shape> {
    pub name: &'shape str,
    pub discriminant: Option<i64>,
    pub attributes: &'shape [VariantAttribute<'shape>],
    pub data: StructType<'shape>,
    pub doc: &'shape [&'shape str],
}

Describes a variant of an enum

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: &'shape str

Name of the jariant, e.g. Foo for enum FooBar { Foo, Bar }

discriminant: Option<i64>

Discriminant value (if available). Might fit in a u8, etc.

attributes: &'shape [VariantAttribute<'shape>]

Attributes set for this variant via the derive macro

data: StructType<'shape>

Fields for this variant (empty if unit, number-named if tuple). IMPORTANT: the offset for the fields already takes into account the size & alignment of the discriminant.

doc: &'shape [&'shape str]

Doc comment for the variant

Implementations

impl<'shape> Variant<'shape>

pub const fn builder() -> VariantBuilder<'shape>

Returns a builder for Variant

pub fn has_arbitrary_attr(&self, content: &'static str) -> bool

Checks whether the Variant has an attribute of form VariantAttribute::Arbitrary with the given content.

Trait Implementations

impl<'shape> Clone for Variant<'shape>

fn clone(&self) -> Variant<'shape>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'shape> Debug for Variant<'shape>

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

Formats the value using the given formatter.

impl<'shape> Hash for Variant<'shape>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'shape> PartialEq for Variant<'shape>

fn eq(&self, other: &Variant<'shape>) -> 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<'shape> Copy for Variant<'shape>

impl<'shape> Eq for Variant<'shape>

impl<'shape> StructuralPartialEq for Variant<'shape>