Struct mycelium_experimental::SkipList

pub struct SkipList { /* fields omitted */ }

A lock-free skip list.

Methods

impl SkipList

pub fn new(collector: Collector) -> SkipList

Returns a new, empty skip list.

pub fn is_empty(&self) -> bool

Returns true if the skip list is empty.

pub fn len(&self) -> usize

Returns the number of entries in the skip list.

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

impl SkipList

pub fn front<'a>(&'a self, guard: &'a Guard) -> Option<Entry>

Returns the entry with the smallest key.

pub fn back<'a>(&'a self, guard: &'a Guard) -> Option<Entry<'a>>

Returns the entry with the largest key.

pub fn contains_key(&self, key: [u8; 16], guard: &Guard) -> bool

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

pub fn get<'a>(&'a self, key: [u8; 16], guard: &'a Guard) -> Option<Entry>

Returns an entry with the specified key.

pub fn lower_bound<'a>(
    &'a self,
    bound: Bound<[u8; 16]>,
    guard: &'a Guard
) -> Option<Entry<'a>>

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>(
    &'a self,
    bound: Bound<[u8; 16]>,
    guard: &'a Guard
) -> Option<Entry<'a>>

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: [u8; 16],
    value: Vec<u8>,
    guard: &Guard
) -> RefEntry

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

Important traits for Iter<'a, 'a>

impl<'a> Iterator for Iter<'a, 'a> type Item = Entry<'a>;

pub fn iter<'a: 'g, 'g>(&'a self, guard: &'g Guard) -> Iter<'a, 'g>

Returns an iterator over all entries in the skip list.

pub fn ref_iter(&self) -> RefIter

Returns an iterator over all entries in the skip list.

impl SkipList

pub fn insert(&self, key: [u8; 16], value: Vec<u8>, guard: &Guard) -> RefEntry

Inserts a key-value pair into the skip list 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(&self, key: [u8; 16], guard: &Guard) -> Option<RefEntry>

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

pub fn pop_front<'a>(&'a self, guard: &'a Guard) -> Option<RefEntry<'a>>

Removes an entry from the front of the skip list.

pub fn pop_back<'a>(&'a self, guard: &'a Guard) -> Option<RefEntry<'a>>

Removes an entry from the back of the skip list.

pub fn clear(&self, guard: &mut Guard)

Iterates over the map and removes every entry.

Trait Implementations

impl Send for SkipList

impl Sync for SkipList

impl Drop for SkipList

fn drop(&mut self)

Executes the destructor for this type.

impl IntoIterator for SkipList

type Item = ([u8; 16], Vec<u8>)

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

Important traits for IntoIter

impl Iterator for IntoIter type Item = ([u8; 16], Vec<u8>);

fn into_iter(self) -> IntoIter

Creates an iterator from a value.

impl Debug for SkipList

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

Formats the value using the given formatter.