Struct PeekEnum

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

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

Implementations

impl<'mem> PeekEnum<'mem>

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 variant_kind_active(self) -> &'static VariantKind

Returns the kind of the active variant (Unit, Tuple, Struct)

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

Returns a Peek handle to a field of a tuple or struct variant

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

Returns a Peek handle to a field of a tuple variant by index

pub fn fields_with_metadata( self, ) -> Box<dyn Iterator<Item = (usize, &'static str, Peek<'mem>, &'static Field)> + 'mem>

Returns an iterator over fields of a struct or tuple variant with metadata

pub fn fields( self, ) -> Box<dyn Iterator<Item = (&'static str, Peek<'mem>)> + 'mem>

Returns an iterator over fields of a struct or tuple variant

Methods from Deref<Target = PeekValue<'mem>>

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

Returns the vtable

pub fn eq(&self, other: &PeekValue<'_>) -> 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: &PeekValue<'_>) -> Option<Ordering>

Compares this scalar with another and returns their ordering

Returns

None if comparison is not supported for this scalar type

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

Compares this scalar with another and returns their ordering

Returns

None if comparison is not supported for this scalar type

pub fn gt(&self, other: &PeekValue<'_>) -> bool

Returns true if this scalar is greater than the other scalar

Returns

false if comparison is not supported for this scalar type

pub fn gte(&self, other: &PeekValue<'_>) -> bool

Returns true if this scalar is greater than or equal to the other scalar

Returns

false if comparison is not supported for this scalar type

pub fn lt(&self, other: &PeekValue<'_>) -> bool

Returns true if this scalar is less than the other scalar

Returns

false if comparison is not supported for this scalar type

pub fn lte(&self, other: &PeekValue<'_>) -> bool

Returns true if this scalar is less than or equal to the other scalar

Returns

false if comparison is not supported for this scalar type

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

Formats this scalar for display

Returns

None if display formatting is not supported for this scalar type

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

Formats this scalar for debug

Returns

None if debug formatting 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) -> OpaqueConst<'mem>

Returns the data

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

Get the scalar type if set.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

type Target = PeekValue<'mem>

The resulting type after dereferencing.

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

Dereferences the value.

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