Struct NiTMap

pub struct NiTMap<K, V> {
    pub __base: NiTMapBase<K, V, NiTDefaultAllocator<NiTMapItem<K, V>>>,
}

A generic map data structure that supports basic operations like insertion, removal, and lookup.

This type is designed to be compatible with C++’s NiTMap and is exposed through FFI bindings.

Note

As far as the requirements in the vtable are concerned, key is supposed to be a Copy type.

Fields

__base: NiTMapBase<K, V, NiTDefaultAllocator<NiTMapItem<K, V>>>

Implementations

impl<K, V> NiTMap<K, V>

pub fn clear(&mut self)

Clears all elements from the map.

This function removes all key-value pairs from the map and resets its state. The map will be empty after this operation.

pub const fn len(&self) -> usize

Returns the number of elements in the map.

pub const fn is_empty(&self) -> bool

Returns true if the map is empty, otherwise false.

impl<K, V> NiTMap<K, V>

where K: Copy,

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

Gets a reference to the value associated with the given key.

pub fn get_mut(&mut self, key: &K) -> Option<&mut V>

Gets a mutable reference to the value associated with the given key.

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

Checks if the map contains the specified key.

pub fn insert(&mut self, key: K, value: V) -> bool

Inserts a new key-value pair into the map.

If the key already exists in the map, this will replace the existing value.

pub fn remove(&mut self, key: &K) -> Option<V>

Removes the key-value pair associated with the given key.

pub const fn iter(&self) -> NiTMapIter<'_, K, V>

Returns an iterator over the map’s key-value pairs.

pub fn keys(&self) -> impl Iterator<Item = &K>

Returns an iterator over the keys in the map.

pub fn values(&self) -> impl Iterator<Item = &V>

Returns an iterator over the values in the map.

Trait Implementations

impl<K: Copy + Clone, V: Clone> Clone for NiTMap<K, V>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

where K: Debug + Copy, V: Debug,

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

Formats the value using the given formatter.

impl<K: Copy, V> Extend<(K, V)> for NiTMap<K, V>

fn extend<T: IntoIterator<Item = (K, V)>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<K, V> Hash for NiTMap<K, V>

where K: Hash + Copy, V: Hash,

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

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<'a, K, V> IntoIterator for &'a NiTMap<K, V>

type Item = (&'a K, &'a V)

The type of the elements being iterated over.

type IntoIter = NiTMapIter<'a, 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> IntoIterator for NiTMap<K, V>

where K: Copy,

type Item = (K, V)

The type of the elements being iterated over.

type IntoIter = NiTMapIntoIter<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> Ord for NiTMap<K, V>

where K: Ord + Copy, V: Ord,

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<K, V> PartialEq for NiTMap<K, V>

where K: Eq + Copy, V: PartialEq,

fn eq(&self, other: &Self) -> 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<K, V> PartialOrd for NiTMap<K, V>

where K: Ord + Copy, V: PartialOrd,

fn partial_cmp(&self, other: &Self) -> 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<K, V> Eq for NiTMap<K, V>

where K: Eq + Copy, V: Eq,