Struct infinitree::fields::Map

source · [−]

pub struct Map<K: 'static + Key, V: 'static + Value>(_);

Expand description

Multithreaded hash map that is always saved atomically

Calling clone() will create a reference to the same instance, and can be easily shared between threads.

For tracking incremental changes to your data structure, look at VersionedMap

Implementations

source

impl<K, V> Map<K, V> where
K: Key,
V: Value,

source

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

Insert a new value for the given key in the map.

source

pub fn update_with<Q, R>(
 &self,
 key: &Q,
 fun: impl FnOnce(&K, &mut Arc<V>) -> R
) -> Option<R> where
 K: Borrow<Q>,
 Q: Hash + Eq + ?Sized,

Update a value with the given key, and return the new value if the key exists.

source

pub fn insert_with(&self, key: K, fun: impl FnMut() -> V) -> Arc<V>

Call the given function to insert a value if it doesn’t exist. Return with the current value to the key.

source

pub fn get<Q>(&self, key: &Q) -> Option<Arc<V>> where
K: Borrow<Q>,
Q: Hash + Eq + ?Sized,

Returns the stored value for a key, or None.

source

pub fn remove<Q>(&self, key: &Q) where
K: Borrow<Q>,
Q: Hash + Eq + ?Sized,

Sets the key as removed in the map.

source

pub fn contains<Q>(&self, key: &Q) -> bool where
K: Borrow<Q>,
Q: Hash + Eq + ?Sized,

Returns if there’s an addition for the specified key.

source

pub fn for_each(&self, callback: impl FnMut(&K, &mut Arc<V>))

Call the function for all additive keys.

source

pub fn len(&self) -> usize

Returns the number of keys.

source

pub fn capacity(&self) -> usize

Return the size of all allocated items.

source

pub fn is_empty(&self) -> bool

True if the map doesn’t contain any items.

Trait Implementations

source

impl<K: Clone + 'static + Key, V: Clone + 'static + Value> Clone for Map<K, V>

source

fn clone(&self) -> Map<K, V>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<K: Default + 'static + Key, V: Default + 'static + Value> Default for Map<K, V>

source

fn default() -> Map<K, V>

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

source

impl<K, V> Index for Map<K, V> where
K: Key + Clone,
V: Value + Clone,

source

fn store_all(&mut self) -> Result<Vec<Intent<Box<dyn Store>>>>

Generate an Intent wrapper for each field in the Index. Read more

source

fn load_all(&mut self) -> Result<Vec<Intent<Box<dyn Load>>>>

Generate an Intent wrapper for each field in the Index. Read more

Auto Trait Implementations

impl<K, V> RefUnwindSafe for Map<K, V>

impl<K, V> Send for Map<K, V>

impl<K, V> Sync for Map<K, V>

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

impl<K, V> UnwindSafe for Map<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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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 for T where
U: From<T>,

const: unstable · 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> Same<T> for T

type Output = T

Should always be Self

source

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

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)

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

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

Struct infinitree::fields::Map

Implementations

impl<K, V> Map<K, V> where K: Key, V: Value,

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

pub fn update_with<Q, R>( &self, key: &Q, fun: impl FnOnce(&K, &mut Arc<V>) -> R) -> Option<R> where K: Borrow<Q>, Q: Hash + Eq + ?Sized,

pub fn insert_with(&self, key: K, fun: impl FnMut() -> V) -> Arc<V>

pub fn get<Q>(&self, key: &Q) -> Option<Arc<V>> where K: Borrow<Q>, Q: Hash + Eq + ?Sized,

pub fn remove<Q>(&self, key: &Q) where K: Borrow<Q>, Q: Hash + Eq + ?Sized,

pub fn contains<Q>(&self, key: &Q) -> bool where K: Borrow<Q>, Q: Hash + Eq + ?Sized,

pub fn for_each(&self, callback: impl FnMut(&K, &mut Arc<V>))

pub fn len(&self) -> usize

pub fn capacity(&self) -> usize

pub fn is_empty(&self) -> bool

Trait Implementations

impl<K: Clone + 'static + Key, V: Clone + 'static + Value> Clone for Map<K, V>

fn clone(&self) -> Map<K, V>

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

impl<K: Default + 'static + Key, V: Default + 'static + Value> Default for Map<K, V>

fn default() -> Map<K, V>

impl<K, V> Index for Map<K, V> where K: Key + Clone, V: Value + Clone,

fn store_all(&mut self) -> Result<Vec<Intent<Box<dyn Store>>>>

fn load_all(&mut self) -> Result<Vec<Intent<Box<dyn Load>>>>

Auto Trait Implementations

impl<K, V> RefUnwindSafe for Map<K, V>

impl<K, V> Send for Map<K, V>

impl<K, V> Sync for Map<K, V>

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

impl<K, V> UnwindSafe for Map<K, V>

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<K, V> Map<K, V> where
K: Key,
V: Value,

pub fn update_with<Q, R>(
&self,
key: &Q,
fun: impl FnOnce(&K, &mut Arc<V>) -> R
) -> Option<R> where
K: Borrow<Q>,
Q: Hash + Eq + ?Sized,

pub fn get<Q>(&self, key: &Q) -> Option<Arc<V>> where
K: Borrow<Q>,
Q: Hash + Eq + ?Sized,

pub fn remove<Q>(&self, key: &Q) where
K: Borrow<Q>,
Q: Hash + Eq + ?Sized,

pub fn contains<Q>(&self, key: &Q) -> bool where
K: Borrow<Q>,
Q: Hash + Eq + ?Sized,

impl<K, V> Index for Map<K, V> where
K: Key + Clone,
V: Value + Clone,

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

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

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

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

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

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

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

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