Struct zng_state_map::OwnedStateMap

pub struct OwnedStateMap<U>(/* private fields */);

Private state map.

The owner of a state map has full access including to the remove and clear methods that are not provided in the StateMapMut type. All mutable references borrowed from this map are also protected to not allow replacement.

The U parameter is tag type that represents the map’s context.

Implementations

impl<U> OwnedStateMap<U>

pub const fn new() -> Self

New default, empty.

pub fn remove<T: StateValue>(&mut self, id: impl Into<StateId<T>>) -> Option<T>

Remove the key.

pub fn clear(&mut self)

Removes all entries.

pub fn borrow(&self) -> StateMapRef<'_, U>

Create tagged read-only reference to the map.

pub fn borrow_mut(&mut self) -> StateMapMut<'_, U>

Crate tagged mutable reference to the map.

Trait Implementations

impl<U> Debug for OwnedStateMap<U>

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

Formats the value using the given formatter.

impl<U> Default for OwnedStateMap<U>

fn default() -> Self

Returns the “default value” for a type.