Struct RbTreeMap

pub struct RbTreeMap<K, V, A>
where
    A: Allocator,
{ /* private fields */ }

A map type based on the ngx_rbtree_t.

This map implementation owns the stored keys and values and ensures that the data is dropped. The order of the elements is an undocumented implementation detail.

This is a ngx-specific high-level type with no direct counterpart in the NGINX code.

Implementations

impl<K, V, A> RbTreeMap<K, V, A>

where A: Allocator,

pub fn allocator(&self) -> &A

Returns a reference to the underlying allocator.

pub fn clear(&mut self)

Clears the tree, removing all elements.

pub fn is_empty(&self) -> bool

Returns true if the tree contains no entries.

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

Returns an iterator over the entries of the tree.

pub fn iter_mut(&mut self) -> IterMut<'_, K, V>

Returns a mutable iterator over the entries of the tree.

impl<K, V, A> RbTreeMap<K, V, A>

where A: Allocator, K: Hash + Ord,

pub fn try_new_in(alloc: A) -> Result<Self, AllocError>

Attempts to create and initialize a new RbTreeMap with specified allocator.

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

where K: Borrow<Q>, Q: Hash + Ord + ?Sized,

Returns a reference to the value corresponding to the key.

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

where K: Borrow<Q>, Q: Hash + Ord + ?Sized,

Returns a mutable reference to the value corresponding to the key.

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

where K: Borrow<Q>, Q: Hash + Ord + ?Sized,

Removes a key from the tree, returning the value at the key if the key was previously in the tree.

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

where K: Borrow<Q>, Q: Hash + Ord + ?Sized,

Removes a key from the tree, returning the stored key and value if the key was previously in the tree.

pub fn try_insert(&mut self, key: K, value: V) -> Result<&mut V, AllocError>

Attempts to insert a new element into the tree.

Trait Implementations

impl<K: Debug, V: Debug, A> Debug for RbTreeMap<K, V, A>

where A: Allocator + Debug,

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

Formats the value using the given formatter.

impl<K, V, A> Drop for RbTreeMap<K, V, A>

where A: Allocator,

fn drop(&mut self)

Executes the destructor for this type.

impl<K, V, A> Send for RbTreeMap<K, V, A>

where A: Send + Allocator, K: Send, V: Send,

impl<K, V, A> Sync for RbTreeMap<K, V, A>

where A: Sync + Allocator, K: Sync, V: Sync,