Struct PeekEnum

pub struct PeekEnum<'mem, 'facet_lifetime> { /* private fields */ }

Lets you read from an enum (implements read-only enum operations)

Implementations

impl<'mem, 'facet_lifetime> PeekEnum<'mem, 'facet_lifetime>

pub fn def(self) -> EnumDef

Returns the enum definition

pub fn repr(self) -> EnumRepr

Returns the enum representation

pub fn variants(self) -> &'static [Variant]

Returns the enum variants

pub fn variant_count(self) -> usize

Returns the number of variants in this enum

pub fn variant_name(self, index: usize) -> Option<&'static str>

Returns the variant name at the given index

pub fn discriminant(self) -> i64

Returns the discriminant value for the current enum value

pub fn variant_index(self) -> usize

Returns the variant index for this enum value

pub fn active_variant(self) -> &'static Variant

Returns the active variant

pub fn variant_name_active(self) -> &'static str

Returns the name of the active variant for this enum value

pub fn field(self, index: usize) -> Option<Peek<'mem, 'facet_lifetime>>

Returns a PeekValue handle to a field of a tuple or struct variant by index

pub fn field_index(self, field_name: &str) -> Option<usize>

Returns the index of a field in the active variant by name

pub fn field_by_name( self, field_name: &str, ) -> Option<Peek<'mem, 'facet_lifetime>>

Returns a PeekValue handle to a field of a tuple or struct variant by name

Methods from Deref<Target = Peek<'mem, 'facet_lifetime>>

pub fn vtable(&self) -> &'static ValueVTable

Returns the vtable

pub fn id(&self) -> ValueId

Returns a unique identifier for this value, usable for cycle detection

pub fn ptr_eq(&self, other: &Peek<'_, '_>) -> bool

Returns true if the two values are pointer-equal

pub fn eq(&self, other: &Peek<'_, '_>) -> Option<bool>

Returns true if this scalar is equal to the other scalar

Returns

false if equality comparison is not supported for this scalar type

pub fn partial_cmp(&self, other: &Peek<'_, '_>) -> Option<Ordering>

Compares this scalar with another and returns their ordering

Returns

None if comparison is not supported for this scalar type

pub fn hash<H: Hasher>(&self, hasher: &mut H) -> bool

Hashes this scalar

Returns

false if hashing is not supported for this scalar type, true otherwise

pub fn type_name(&self, f: &mut Formatter<'_>, opts: TypeNameOpts) -> Result

Returns the type name of this scalar

Arguments

• f - A mutable reference to a core::fmt::Formatter
• opts - The TypeNameOpts to use for formatting

Returns

The result of the type name formatting

pub fn shape(&self) -> &'static Shape

Returns the shape

pub fn data(&self) -> PtrConst<'mem>

Returns the data

pub fn scalar_type(&self) -> Option<ScalarType>

Get the scalar type if set.

pub fn get<T: Facet<'facet_lifetime>>(&self) -> Result<&T, ReflectError>

Read the value from memory into a Rust value.

Panics

Panics if the shape doesn’t match the type T.

Trait Implementations

impl<'mem, 'facet_lifetime> Clone for PeekEnum<'mem, 'facet_lifetime>

fn clone(&self) -> PeekEnum<'mem, 'facet_lifetime>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PeekEnum<'_, '_>

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

Formats the value using the given formatter.

impl<'mem, 'facet_lifetime> Deref for PeekEnum<'mem, 'facet_lifetime>

type Target = Peek<'mem, 'facet_lifetime>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'mem, 'facet_lifetime> HasFields<'mem, 'facet_lifetime> for PeekEnum<'mem, 'facet_lifetime>

fn fields( &self, ) -> impl DoubleEndedIterator<Item = (Field, Peek<'mem, 'facet_lifetime>)>

Iterates over all fields in this type, providing both field metadata and value

fn fields_for_serialize( &self, ) -> impl DoubleEndedIterator<Item = (Field, Peek<'mem, 'facet_lifetime>)>

Iterates over fields in this type that should be included when it is serialized

impl<'mem, 'facet_lifetime> Copy for PeekEnum<'mem, 'facet_lifetime>