Struct PokeValue

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

Lets you modify an initialized value (implements read-write ValueVTable proxies)

Implementations

impl<'mem> PokeValue<'mem>

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

Creates a value write-proxy from its essential components

Safety

The data must be a valid, initialized instance of the type described by shape.

pub fn into_value(self) -> Self

Coerce back into a PokeValue

pub fn typed<T: Facet>(self) -> Result<TypedPokeValue<'mem, T>, Self>

Converts to a type-checked TypedPokeValue<T> if the shape matches type T

Returns None if the shape doesn’t match the type T.

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

Shape getter

pub fn as_peek(&self) -> Peek<'_>

Gets a read-only view of the value

pub unsafe fn data(&mut self) -> Opaque<'mem>

Exposes the internal data buffer as a mutable reference

Safety

The caller must ensure that they don’t violate any invariants of the underlying type.

pub fn replace<'src, T>(self, value: T) -> Opaque<'mem>

where T: Facet + 'src,

Replace the current value with a new one of the same type

This function replaces the existing value with a new one of type T, checking that T exactly matches the expected shape.

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

Format the value using its Debug implementation

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

Format the value using its Display implementation

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

Get the scalar type if set.

Trait Implementations

impl Debug for PokeValue<'_>

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

Formats the value using the given formatter.