Struct Map 

pub struct Map<K, V> { /* private fields */ }

Immutable, reference-counted map from K to V, sharing its underlying MapObj with C++. Cloning is cheap (it bumps the refcount).

Implementations

impl<K, V> Map<K, V>

where K: AnyCompatible, V: AnyCompatible,

pub fn new() -> Self

Creates a new, empty map (via an ffi.Map() call to the C++ runtime).

pub fn len(&self) -> usize

Returns the number of entries in the map by reading the MapObj header directly (no FFI call), like Array::len.

pub fn is_empty(&self) -> bool

Returns true if the map contains no entries.

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

Returns true if key is present in the map.

Panics if the lookup fails in the C++ runtime (e.g. key is not hashable); use Map::get when such failures must be recovered from. Passing a key whose type does not match the map’s key type is undefined (currently reads as false; see Map::get); debug builds assert against it.

pub fn get(&self, key: &K) -> Result<Option<V>>

Looks up key, returning Ok(None) if absent, or Err if the lookup fails in the C++ runtime (e.g. key is not hashable) or the stored value cannot be converted to V. The map is immutable, so the lookup (existence check then ffi.MapGetItem) cannot race with itself.

Passing a key whose type does not match the map’s key type is undefined: the result is unspecified — it currently reads as absent (Ok(None)) because a pure lookup hashes the key rather than retrieving one, so the mismatch cannot be surfaced as an Err the way a value mismatch (or Map::iter, which retrieves keys) is. Debug builds assert against this misuse.

pub fn iter(&self) -> MapItems<K, V>

Returns an iterator over the (key, value) pairs of the map.

pub fn keys(&self) -> MapKeys<K>

Returns an iterator over the keys of the map.

pub fn values(&self) -> MapValues<V>

Returns an iterator over the values of the map.

Trait Implementations

impl<K, V> AnyCompatible for Map<K, V>

where K: AnyCompatible, V: AnyCompatible,

fn type_str() -> String

the type string of the type

unsafe fn check_any_strict(data: &TVMFFIAny) -> bool

unsafe fn copy_to_any_view(src: &Self, data: &mut TVMFFIAny)

the value to copy to TVMFFIAny

unsafe fn move_to_any(src: Self, data: &mut TVMFFIAny)

consume the value to move to Any

unsafe fn copy_from_any_view_after_check(data: &TVMFFIAny) -> Self

Copy value from TVMFFIAny after checking caller must ensure that the value is compatible with the type

unsafe fn move_from_any_after_check(data: &mut TVMFFIAny) -> Self

the value to move from TVMFFIAny NOTE: pay very careful attention to avoid memory leak!

unsafe fn try_cast_from_any_view(data: &TVMFFIAny) -> Result<Self, ()>

try to cast the value from AnyView

fn get_mismatch_type_info(data: &TVMFFIAny) -> String

Get the type key of a type when TryCastFromAnyView fails.

impl<K: AnyCompatible, V: AnyCompatible> ArgIntoRef for &Map<K, V>

type Target = Map<K, V>

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

impl<K: AnyCompatible, V: AnyCompatible> ArgIntoRef for Map<K, V>

type Target = Map<K, V>

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

impl<K, V> Clone for Map<K, V>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K, V> Debug for Map<K, V>

where K: AnyCompatible, V: AnyCompatible,

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

Formats the value using the given formatter.

impl<K, V> Default for Map<K, V>

where K: AnyCompatible, V: AnyCompatible,

fn default() -> Self

Returns the “default value” for a type.

impl<K, V> Deref for Map<K, V>

type Target = MapObj

The resulting type after dereferencing.

fn deref(&self) -> &MapObj

Dereferences the value.

impl<K, V> FromIterator<(K, V)> for Map<K, V>

where K: AnyCompatible, V: AnyCompatible,

fn from_iter<I: IntoIterator<Item = (K, V)>>(iter: I) -> Self

Duplicate keys follow C++ ffi.Map semantics: a later pair overwrites an earlier one, so the resulting map may be smaller than the iterator.

impl<'a, K: AnyCompatible, V: AnyCompatible> IntoArgHolder for &'a Map<K, V>

type Target = &'a Map<K, V>

fn into_arg_holder(self) -> Self::Target

impl<K: AnyCompatible, V: AnyCompatible> IntoArgHolder for Map<K, V>

type Target = Map<K, V>

fn into_arg_holder(self) -> Self::Target

impl<K, V> IntoIterator for &Map<K, V>

where K: AnyCompatible, V: AnyCompatible,

type Item = (K, V)

The type of the elements being iterated over.

type IntoIter = MapIter<(K, V)>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K, V> ObjectRefCore for Map<K, V>

type ContainerType = MapObj

fn data(this: &Self) -> &ObjectArc<MapObj>

fn into_data(this: Self) -> ObjectArc<MapObj>

fn from_data(data: ObjectArc<MapObj>) -> Self

impl<K, V> TryFrom<Any> for Map<K, V>

where K: AnyCompatible, V: AnyCompatible,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Any) -> Result<Self>

Performs the conversion.

impl<'a, K, V> TryFrom<AnyView<'a>> for Map<K, V>

where K: AnyCompatible, V: AnyCompatible,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AnyView<'a>) -> Result<Self>

Performs the conversion.