Enum Peek

#[non_exhaustive]
pub enum Peek<'mem> {
    Value(PeekValue<'mem>),
    List(PeekList<'mem>),
    Map(PeekMap<'mem>),
    Struct(PeekStruct<'mem>),
    Enum(PeekEnum<'mem>),
    Option(PeekOption<'mem>),
}

Lets you peek at the innards of a value

It’s possible (in some cases..) to escape the borrow checker by setting 'mem to 'static, in which case, you’re entirely on your own.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Value(PeekValue<'mem>)

cf. PeekValue

List(PeekList<'mem>)

cf. PeekList

Map(PeekMap<'mem>)

cf. PeekMap

Struct(PeekStruct<'mem>)

cf. PeekStruct

Enum(PeekEnum<'mem>)

cf. PeekEnum

Option(PeekOption<'mem>)

cf. PeekOption

Implementations

impl<'mem> Peek<'mem>

pub fn new<S: Facet>(s: &'mem S) -> Self

Creates a new peek from a reference to some initialized value that implements Facet

pub unsafe fn unchecked_new( data: OpaqueConst<'mem>, shape: &'static Shape, ) -> Self

Creates a new peek, for easy manipulation of some opaque data.

Safety

data must be initialized and well-aligned, and point to a value of the type described by shape.

pub fn as_value(self) -> PeekValue<'mem>

Coerce this to a value so we can use display, debug, etc.

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 Peek<'mem>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Peek<'_>

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

Formats the value using the given formatter.

impl<'mem> Deref for Peek<'mem>

type Target = PeekValue<'mem>

The resulting type after dereferencing.

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

Dereferences the value.

impl Display for Peek<'_>

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

Formats the value using the given formatter.

impl<'mem> Copy for Peek<'mem>