Struct PeekMap

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

Lets you read from a map (implements read-only facet_core::MapVTable proxies)

Implementations

impl<'mem> PeekMap<'mem>

pub fn new(value: PeekValue<'mem>, def: MapDef) -> Self

Constructor

pub fn len(&self) -> usize

Get the number of entries in the map

pub fn is_empty(&self) -> bool

Returns true if the map is empty

pub fn contains_key(&self, key: &impl Facet) -> bool

Check if the map contains a key

pub fn get<'k>(&self, key: &'k impl Facet) -> Option<Peek<'mem>>

Get a value from the map for the given key

pub fn iter(self) -> PeekMapIter<'mem>

Returns an iterator over the key-value pairs in the map

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'mem> Deref for PeekMap<'mem>

type Target = PeekValue<'mem>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'mem> IntoIterator for &'mem PeekMap<'mem>

type Item = (Peek<'mem>, Peek<'mem>)

The type of the elements being iterated over.

type IntoIter = PeekMapIter<'mem>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'mem> Copy for PeekMap<'mem>