Struct Peek

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

Lets you read from a value (implements read-only ValueVTable proxies)

Implementations

impl<'mem> Peek<'mem>

pub fn new<'a, T>(t: &'a T) -> Peek<'mem>

where T: Facet<'mem>,

Creates a new PeekValue instance for a value of type T.

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

Creates a new PeekValue instance without checking the type.

Safety

This function is unsafe because it doesn’t check if the provided data and shape are compatible. The caller must ensure that the data is valid for the given shape.

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>(&self, hasher: &mut H) -> bool

where H: Hasher,

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<(), Error>

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 const fn shape(&self) -> &'static Shape

Returns the shape

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

Returns the data

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

Get the scalar type if set.

pub fn get<'a, T>(&self) -> Result<&'a T, ReflectError>

where T: Facet<'a>,

Read the value from memory into a Rust value.

Panics

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

pub fn into_struct(self) -> Result<PeekStruct<'mem>, ReflectError>

Tries to identify this value as a struct

pub fn into_enum(self) -> Result<PeekEnum<'mem>, ReflectError>

Tries to identify this value as an enum

pub fn into_map(self) -> Result<PeekMap<'mem>, ReflectError>

Tries to identify this value as a map

pub fn into_list(self) -> Result<PeekList<'mem>, ReflectError>

Tries to identify this value as a list

pub fn into_smart_pointer(self) -> Result<PeekSmartPointer<'mem>, ReflectError>

Tries to identify this value as a smart pointer

pub fn into_option(self) -> Result<PeekOption<'mem>, ReflectError>

Tries to identify this value as an option

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<(), Error>

Formats the value using the given formatter.

impl Display for Peek<'_>

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

Formats the value using the given formatter.

impl Hash for Peek<'_>

fn hash<H>(&self, hasher: &mut H)

where H: Hasher,

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 PartialEq for Peek<'_>

fn eq(&self, other: &Peek<'_>) -> 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 PartialOrd for Peek<'_>

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

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

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