Skip to main content

SharedMap

Struct SharedMap 

Source
pub struct SharedMap<K: Eq + Clone + Hash, V>(/* private fields */);
Expand description

Concurrent map wrapper over DashMap providing ergonomic scoped access.

Implementations§

Source§

impl<K: Eq + Hash + Clone, V> SharedMap<K, V>

Source

pub fn new() -> Self

Create a new concurrent map.

Source

pub fn get_cloned(&self, key: &K) -> Option<V>
where V: Clone,

Get an owned clone of a value.

This releases the map entry guard immediately, so the entry may be removed or replaced while the caller is still using the clone. Use this only when stale clones are acceptable. Prefer Self::with or Self::with_mut when later work depends on the entry still being present.

Source

pub fn with<F, R>(&self, key: &K, f: F) -> Option<R>
where F: FnOnce(&V) -> R,

Read a value for a key using a closure.

Caution: f runs while the entry guard is held. Avoid re-entering this SharedMap from inside the closure.

Source

pub fn with_mut<F, R>(&self, key: &K, f: F) -> Option<R>
where F: FnOnce(&mut V) -> R,

Mutate a value for a key using a closure.

Caution: f runs while the entry guard is held. Avoid re-entering this SharedMap from inside the closure.

Source

pub fn with_mut_or_insert_with<F, D, R>(&self, key: K, default: D, f: F) -> R
where F: FnOnce(&mut V) -> R, D: FnOnce() -> V,

Mutate an entry, inserting a value produced by default when absent.

Source

pub fn with_mut_or_default<F, R>(&self, key: K, f: F) -> R
where V: Default, F: FnOnce(&mut V) -> R,

Mutate an entry, inserting its default value when absent.

Source

pub fn for_each<F, Ret>(&self, f: F)
where F: FnMut(K, &V) -> Ret,

Iterate over all entries immutably.

Caution: f runs while an iterator entry guard is held. Avoid re-entering this SharedMap from inside the closure.

Source

pub fn for_each_mut<F, Ret>(&self, f: F)
where F: FnMut(K, &mut V) -> Ret,

Iterate over all entries mutably.

Caution: f runs while an iterator entry guard is held. Avoid re-entering this SharedMap from inside the closure.

Source

pub fn try_for_each_mut<F, E>(&self, f: F) -> Result<(), E>
where F: FnMut(K, &mut V) -> Result<(), E>,

Fallible mutable iteration over all entries.

Caution: f runs while an iterator entry guard is held. Avoid re-entering this SharedMap from inside the closure.

Source

pub fn try_for_each<F, E>(&self, f: F) -> Result<(), E>
where F: FnMut(K, &V) -> Result<(), E>,

Fallible iteration over all entries.

Caution: f runs while an iterator entry guard is held. Avoid re-entering this SharedMap from inside the closure.

Source

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

Insert a key-value pair.

Source

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

Remove a key.

Source

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

Check if a key exists.

Source

pub fn retain<F>(&self, f: F)
where F: FnMut(&K, &mut V) -> bool,

Retain entries matching predicate.

Caution: f runs while DashMap is mutating internal shards. Avoid re-entering this SharedMap from inside the predicate.

Source

pub fn keys(&self) -> Vec<K>
where K: Clone,

Collect all keys.

Source

pub fn len(&self) -> usize

Number of entries.

Source

pub fn is_empty(&self) -> bool

Check if empty.

Source

pub fn clear(&self)

Clears the collection.

Trait Implementations§

Source§

impl<K: Eq + Clone + Hash, V> Clone for SharedMap<K, V>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<K: Debug + Eq + Clone + Hash, V: Debug> Debug for SharedMap<K, V>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<K: Eq + Hash + Clone, V> Default for SharedMap<K, V>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<K, V> !RefUnwindSafe for SharedMap<K, V>

§

impl<K, V> !UnwindSafe for SharedMap<K, V>

§

impl<K, V> Freeze for SharedMap<K, V>

§

impl<K, V> Send for SharedMap<K, V>
where K: Send + Sync, V: Send + Sync,

§

impl<K, V> Sync for SharedMap<K, V>
where K: Send + Sync, V: Send + Sync,

§

impl<K, V> Unpin for SharedMap<K, V>

§

impl<K, V> UnsafeUnpin for SharedMap<K, V>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more