Struct crossbeam_skiplist::map::SkipMap

pub struct SkipMap<K, V> { /* fields omitted */ }

A map based on a lock-free skip list.

Implementations

impl<K, V> SkipMap<K, V>

pub fn new() -> SkipMap<K, V>

Returns a new, empty map.

pub fn is_empty(&self) -> bool

Returns true if the map is empty.

pub fn len(&self) -> usize

Returns the number of entries in the map.

If the map is being concurrently modified, consider the returned number just an approximation without any guarantees.

impl<K, V> SkipMap<K, V> where
    K: Ord, 

pub fn front(&self) -> Option<Entry<'_, K, V>>

Returns the entry with the smallest key.

pub fn back(&self) -> Option<Entry<'_, K, V>>

Returns the entry with the largest key.

pub fn contains_key<Q: ?Sized>(&self, key: &Q) -> bool where
    K: Borrow<Q>,
    Q: Ord, 

Returns true if the map contains a value for the specified key.

pub fn get<Q: ?Sized>(&self, key: &Q) -> Option<Entry<'_, K, V>> where
    K: Borrow<Q>,
    Q: Ord, 

Returns an entry with the specified key.

pub fn lower_bound<'a, Q: ?Sized>(
    &'a self,
    bound: Bound<&Q>
) -> Option<Entry<'a, K, V>> where
    K: Borrow<Q>,
    Q: Ord, 

Returns an Entry pointing to the lowest element whose key is above the given bound. If no such element is found then None is returned.

pub fn upper_bound<'a, Q: ?Sized>(
    &'a self,
    bound: Bound<&Q>
) -> Option<Entry<'a, K, V>> where
    K: Borrow<Q>,
    Q: Ord, 

Returns an Entry pointing to the highest element whose key is below the given bound. If no such element is found then None is returned.

pub fn get_or_insert(&self, key: K, value: V) -> Entry<'_, K, V>

Finds an entry with the specified key, or inserts a new key-value pair if none exist.

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

Returns an iterator over all entries in the map.

pub fn range<Q: ?Sized, R>(&self, range: R) -> Range<'_, Q, R, K, V> where
    K: Borrow<Q>,
    R: RangeBounds<Q>,
    Q: Ord, 

Returns an iterator over a subset of entries in the skip list.

impl<K, V> SkipMap<K, V> where
    K: Ord + Send + 'static,
    V: Send + 'static, 

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

Inserts a key-value pair into the map and returns the new entry.

If there is an existing entry with this key, it will be removed before inserting the new one.

pub fn remove<Q: ?Sized>(&self, key: &Q) -> Option<Entry<'_, K, V>> where
    K: Borrow<Q>,
    Q: Ord, 

Removes an entry with the specified key from the map and returns it.

pub fn pop_front(&self) -> Option<Entry<'_, K, V>>

Removes an entry from the front of the map.

pub fn pop_back(&self) -> Option<Entry<'_, K, V>>

Removes an entry from the back of the map.

pub fn clear(&self)

Iterates over the map and removes every entry.

Trait Implementations

impl<K, V> Debug for SkipMap<K, V> where
    K: Ord + Debug,
    V: Debug, 

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

Formats the value using the given formatter.

impl<K, V> Default for SkipMap<K, V>

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

Returns the “default value” for a type.

impl<K, V> FromIterator<(K, V)> for SkipMap<K, V> where
    K: Ord, 

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

Creates a value from an iterator.

impl<K, V> IntoIterator for SkipMap<K, V>

type Item = (K, V)

The type of the elements being iterated over.

type IntoIter = IntoIter<K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IntoIter<K, V>

Creates an iterator from a value.

impl<'a, K, V> IntoIterator for &'a SkipMap<K, V> where
    K: Ord, 

type Item = Entry<'a, K, V>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Iter<'a, K, V>

Creates an iterator from a value.