Struct Variant

pub struct Variant<'input> { /* private fields */ }

A variant.

A variant consists of a discriminant value that selects the variant, and a list of members that are valid when the variant is selected.

Implementations

impl<'input> Variant<'input>

pub fn discriminant_value(&self) -> Option<u64>

The discriminant value which selects this variant.

The sign of this value depends on the type of the discriminant member.

pub fn name(&self) -> Option<&str>

The name of the variant.

Currently this is only set for Rust enums.

pub fn members(&self) -> &[Member<'input>]

The members for this variant.

pub fn bit_offset(&self) -> u64

The smallest offset in bits for a member of this variant.

pub fn bit_size(&self, hash: &FileHash<'_>) -> Option<u64>

The size in bits for the members of this variant, excluding leading and trailing padding.

pub fn layout<'me>( &'me self, bit_offset: u64, bit_size: Option<u64>, hash: &FileHash<'input>, ) -> Vec<Layout<'input, 'me>>

The layout of members of this variant within a variant part.

The given bit_offset and bit_size should be for the variant part.

pub fn cmp_id( _hash_a: &FileHash<'_>, a: &Variant<'_>, _hash_b: &FileHash<'_>, b: &Variant<'_>, ) -> Ordering

Compare the identifying information of two types.

Variants are considered equal if the discriminant values are equal.

This can be used to sort, and to determine if two types refer to the same definition (even if there are differences in the definitions).

Trait Implementations

impl<'input> Clone for Variant<'input>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'input> Debug for Variant<'input>

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

Formats the value using the given formatter.

impl<'input> Default for Variant<'input>

fn default() -> Variant<'input>

Returns the “default value” for a type.