Struct NodeGuard 

pub struct NodeGuard<'a, K, V, S, P>
where
    P: TreePolicy<K = K, V = V, S = S>,
{ /* private fields */ }

A guarded mutable reference to an augmented tree node.

Modifying the underlying value via this guard automatically propagates augmentation updates up the tree when it goes out of scope.

Implementations

impl<K, V, S, P> NodeGuard<'_, K, V, S, P>

where P: TreePolicy<K = K, V = V, S = S>,

pub fn key(&self) -> &K

Returns a reference to the key of the guarded node.

pub fn stats(&self) -> &S

Returns a reference to the statistics of the guarded node.

pub fn value_mut(&mut self) -> &mut V

Returns a mutable reference to the value of the guarded node.

pub fn value(&self) -> &V

Returns a reference to the value of the guarded node.

Trait Implementations

impl<K, V, S, P> AsMut<V> for NodeGuard<'_, K, V, S, P>

where P: TreePolicy<K = K, V = V, S = S>,

fn as_mut(&mut self) -> &mut V

Converts this type into a mutable reference of the (usually inferred) input type.

impl<'a, K: Debug, V: Debug, S: Debug, P> Debug for NodeGuard<'a, K, V, S, P>

where P: TreePolicy<K = K, V = V, S = S> + Debug,

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

Formats the value using the given formatter.

impl<K, V, S, P> Deref for NodeGuard<'_, K, V, S, P>

where P: TreePolicy<K = K, V = V, S = S>,

type Target = V

The resulting type after dereferencing.

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

Dereferences the value.

impl<K, V, S, P> DerefMut for NodeGuard<'_, K, V, S, P>

where P: TreePolicy<K = K, V = V, S = S>,

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<K, V, S, P> Drop for NodeGuard<'_, K, V, S, P>

where P: TreePolicy<K = K, V = V, S = S>,

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.