[go: up one dir, main page]
contrie::map

Struct ConMap

Source 
pub struct ConMap<K, V, S = RandomState>
where
    K: Hash + Eq + 'static,
    V: ?Sized + 'static,
{ /* private fields */ }
Expand description

A concurrent map.

This flavour stores the data as Arc<Element<K, V>>. This allows returning handles to the held values cheaply even if the data is larger or impossible to clone. This has several consequences:

  • It is sometimes less convenient to use.
  • It allows the values to be ?Sized ‒ you can store trait objects or slices as the values (not the keys).
  • Entries can be shared between multiple maps.
  • Cloning of the map doesn’t clone the data, it will point to the same objects.
  • There’s another indirection in play.

Iteration returns (cloned) handles to the elements. The FromIterator and Extend traits accept both tuples and element handles. Furthermore, the Extend is also implemented for shared references (to allow extending the same map concurrently from multiple threads).

TODO: Support for rayon iterators/extend.

If this is not suitable, the CloneConMap can be used instead (TODO: Implement it).

§Examples

use contrie::ConMap;
use crossbeam_utils::thread;

let map = ConMap::new();

thread::scope(|s| {
    s.spawn(|_| {
        map.insert("hello", 1);
    });
    s.spawn(|_| {
        map.insert("world", 2);
    });
}).unwrap();
assert_eq!(1, *map.get("hello").unwrap().value());
assert_eq!(2, *map.get("world").unwrap().value());
use std::sync::Arc;
use contrie::map::{ConMap, Element};
let map_1: ConMap<usize, [usize]> = ConMap::new();

map_1.insert_element(Arc::new(Element::new(42, [1, 2, 3])));
map_1.insert_element(Arc::new(Element::new(43, [1, 2, 3, 4])));

assert_eq!(3, map_1.get(&42).unwrap().value().len());

let map_2 = ConMap::new();
map_2.insert_element(map_1.get(&43).unwrap());

Implementations§

Source§

impl<K, V> ConMap<K, V>
where K: Hash + Eq + 'static, V: ?Sized + 'static,

Source

pub fn new() -> Self

Creates a new empty map.

Source§

impl<K, V, S> ConMap<K, V, S>
where K: Hash + Eq + 'static, V: 'static, S: BuildHasher,

Source

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

Inserts a new element.

Any previous element with the same key is replaced and returned.

Source

pub fn get_or_insert( &self, key: K, value: V, ) -> ExistingOrNew<Arc<Element<K, V>>>

Looks up or inserts an element.

It looks up an element. If it isn’t present, the provided one is inserted instead. Either way, an element is returned.

Source

pub fn get_or_insert_with<F>( &self, key: K, create: F, ) -> ExistingOrNew<Arc<Element<K, V>>>
where F: FnOnce() -> V,

Looks up or inserts a newly created element.

It looks up an element. If it isn’t present, the provided closure is used to create a new one insert it. Either way, an element is returned.

§Quirks

Due to races in case of concurrent accesses, the closure may be called even if the value is not subsequently inserted and an existing element is returned. This should be relatively rare (another thread must insert the new element between this method observes an empty slot and manages to insert the new element).

Source

pub fn get_or_insert_default(&self, key: K) -> ExistingOrNew<Arc<Element<K, V>>>
where V: Default,

Looks up or inserts a default value of an element.

This is like get_or_insert_with, but a default value is used instead of manually providing a closure.

Source§

impl<K, V, S> ConMap<K, V, S>
where K: Hash + Eq, V: ?Sized, S: BuildHasher,

Source

pub fn with_hasher(hasher: S) -> Self

Creates a new empty map, but with the provided hasher implementation.

Source

pub fn insert_element( &self, element: Arc<Element<K, V>>, ) -> Option<Arc<Element<K, V>>>

Inserts a new element.

This acts the same as insert, but takes the already created element. It can be used when:

  • V: ?Sized.
  • You want to insert the same element into multiple maps.
Source

pub fn get_or_insert_with_element<F>( &self, key: K, create: F, ) -> ExistingOrNew<Arc<Element<K, V>>>
where F: FnOnce(K) -> Arc<Element<K, V>>,

Looks up or inserts a new element.

This is the same as get_or_insert_with, but the closure returns a pre-created element. This can be used when:

  • V: ?Sized.
  • You want to insert the same element into multiple maps.
Source

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

Looks up an element.

Source

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

Removes an element identified by the given key, returning it.

Source§

impl<K, V, S> ConMap<K, V, S>
where K: Hash + Eq, V: ?Sized,

Source

pub fn is_empty(&self) -> bool

Checks if the map is currently empty.

Note that due to the nature of concurrent map, this is inherently racy ‒ another thread may add or remove elements between you call this method and act based on the result.

Source

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

Returns an iterator through the elements of the map.

Trait Implementations§

Source§

impl<K, V, S> Clone for ConMap<K, V, S>
where K: Hash + Eq, V: ?Sized, S: Clone + BuildHasher,

Source§

fn clone(&self) -> Self

Returns a duplicate 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, V, S> Debug for ConMap<K, V, S>
where K: Debug + Hash + Eq, V: Debug + ?Sized,

Source§

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

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

impl<K, V> Default for ConMap<K, V>
where K: Hash + Eq, V: ?Sized,

Source§

fn default() -> Self

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

impl<'a, K, V, S> Extend<(K, V)> for &'a ConMap<K, V, S>
where K: Hash + Eq, S: BuildHasher,

Source§

fn extend<T>(&mut self, iter: T)
where T: IntoIterator<Item = (K, V)>,

Extends a collection with the contents of an iterator. Read more
Source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
Source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
Source§

impl<K, V, S> Extend<(K, V)> for ConMap<K, V, S>
where K: Hash + Eq, S: BuildHasher,

Source§

fn extend<T>(&mut self, iter: T)
where T: IntoIterator<Item = (K, V)>,

Extends a collection with the contents of an iterator. Read more
Source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
Source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
Source§

impl<'a, K, V, S> Extend<Arc<Element<K, V>>> for &'a ConMap<K, V, S>
where K: Hash + Eq, V: ?Sized, S: BuildHasher,

Source§

fn extend<T>(&mut self, iter: T)
where T: IntoIterator<Item = Arc<Element<K, V>>>,

Extends a collection with the contents of an iterator. Read more
Source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
Source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
Source§

impl<K, V, S> Extend<Arc<Element<K, V>>> for ConMap<K, V, S>
where K: Hash + Eq, V: ?Sized, S: BuildHasher,

Source§

fn extend<T>(&mut self, iter: T)
where T: IntoIterator<Item = Arc<Element<K, V>>>,

Extends a collection with the contents of an iterator. Read more
Source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
Source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
Source§

impl<K, V> FromIterator<(K, V)> for ConMap<K, V>
where K: Hash + Eq,

Source§

fn from_iter<T>(iter: T) -> Self
where T: IntoIterator<Item = (K, V)>,

Creates a value from an iterator. Read more
Source§

impl<K, V> FromIterator<Arc<Element<K, V>>> for ConMap<K, V>
where K: Hash + Eq, V: ?Sized,

Source§

fn from_iter<T>(iter: T) -> Self
where T: IntoIterator<Item = Arc<Element<K, V>>>,

Creates a value from an iterator. Read more
Source§

impl<K, V> FromParallelIterator<(K, V)> for ConMap<K, V>
where K: Hash + Eq + Send + Sync, V: Send + Sync,

Source§

fn from_par_iter<T>(par_iter: T) -> Self
where T: IntoParallelIterator<Item = (K, V)>,

Creates an instance of the collection from the parallel iterator par_iter. Read more
Source§

impl<K, V> FromParallelIterator<Arc<Element<K, V>>> for ConMap<K, V>
where K: Hash + Eq + Send + Sync, V: ?Sized + Send + Sync,

Source§

fn from_par_iter<T>(par_iter: T) -> Self
where T: IntoParallelIterator<Item = Arc<Element<K, V>>>,

Creates an instance of the collection from the parallel iterator par_iter. Read more
Source§

impl<'a, K, V, S> IntoIterator for &'a ConMap<K, V, S>
where K: Hash + Eq, V: ?Sized,

Source§

type Item = Arc<Element<K, V>>

The type of the elements being iterated over.
Source§

type IntoIter = Iter<'a, K, V, S>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl<'a, K, V, S> ParallelExtend<(K, V)> for &'a ConMap<K, V, S>
where K: Hash + Eq + Send + Sync, S: BuildHasher + Sync, V: Send + Sync,

Source§

fn par_extend<T>(&mut self, par_iter: T)
where T: IntoParallelIterator<Item = (K, V)>,

Extends an instance of the collection with the elements drawn from the parallel iterator par_iter. Read more
Source§

impl<K, V, S> ParallelExtend<(K, V)> for ConMap<K, V, S>
where K: Hash + Eq + Send + Sync, S: BuildHasher + Sync, V: Send + Sync,

Source§

fn par_extend<T>(&mut self, par_iter: T)
where T: IntoParallelIterator<Item = (K, V)>,

Extends an instance of the collection with the elements drawn from the parallel iterator par_iter. Read more
Source§

impl<'a, K, V, S> ParallelExtend<Arc<Element<K, V>>> for &'a ConMap<K, V, S>
where K: Hash + Eq + Send + Sync, V: ?Sized + Send + Sync, S: BuildHasher + Sync,

Source§

fn par_extend<T>(&mut self, par_iter: T)
where T: IntoParallelIterator<Item = Arc<Element<K, V>>>,

Extends an instance of the collection with the elements drawn from the parallel iterator par_iter. Read more
Source§

impl<K, V, S> ParallelExtend<Arc<Element<K, V>>> for ConMap<K, V, S>
where K: Hash + Eq + Send + Sync, V: ?Sized + Send + Sync, S: BuildHasher + Sync,

Source§

fn par_extend<T>(&mut self, par_iter: T)
where T: IntoParallelIterator<Item = Arc<Element<K, V>>>,

Extends an instance of the collection with the elements drawn from the parallel iterator par_iter. Read more

Auto Trait Implementations§

§

impl<K, V, S = RandomState> !Freeze for ConMap<K, V, S>

§

impl<K, V, S> RefUnwindSafe for ConMap<K, V, S>
where S: RefUnwindSafe, K: RefUnwindSafe, V: RefUnwindSafe + ?Sized,

§

impl<K, V, S> Send for ConMap<K, V, S>
where S: Send, K: Sync + Send, V: Sync + Send + ?Sized,

§

impl<K, V, S> Sync for ConMap<K, V, S>
where S: Sync, K: Sync + Send, V: Sync + Send + ?Sized,

§

impl<K, V, S> Unpin for ConMap<K, V, S>
where S: Unpin, V: ?Sized,

§

impl<K, V, S> UnwindSafe for ConMap<K, V, S>
where S: UnwindSafe, K: RefUnwindSafe, V: RefUnwindSafe + ?Sized,

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, 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.