Struct hashvec::HashVec

source · [−]

pub struct HashVec<K: Eq + Hash, V> { /* private fields */ }

Implementations

source

impl<K: Eq + Hash, V> HashVec<K, V>

source

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

Creates a new, empty map.

source

pub fn with_capacity(capacity: usize) -> HashVec<K, V>

Creates a new, empty hashvec with the specified capacity.

source

pub fn from_vec(v: Vec<(K, V)>) -> HashVec<K, V>

Creates a hashvec from a vector of key-value pairs.

Internally, this uses HashVec::append_vec(), which means that redundant keys’ entries will be overwritten and moved to the end of the hashvec sequentially.

source

pub fn capacity(&self) -> usize

Returns the number of elements the hashvec can hold without reallocating.

source

pub fn len(&self) -> usize

Returns the number of elements in the hashvec.

source

pub fn is_empty(&self) -> bool

Returns true if the hashvec contains no elements.

source

pub fn clear(&mut self)

Clears the hashvec, removing all entries.

Keep in mind this will not reallocate memory.

source

pub fn insert(&mut self, k: K, v: V)

Inserts an entry into the hashvec, or replaces an existing one.

source

pub fn push(&mut self, entry: (K, V))

Appends an entry to the back of the hashvec.

If an entry with an identical key was already in the hashvec, it is removed before the new entry is inserted.

Panics

Panics if the new capacity either overflows usize or exceeds isize::MAX bytes.

source

pub fn pop(&mut self) -> Option<(K, V)>

Removes the last entry from the hashvec and returns it (or None if the hashvec is empty).

source

pub fn append(&mut self, other: &mut HashVec<K, V>)

Appends all entries of other into Self, leaving other empty.

Panics

Panics if the number of elements in the hashvec either overflows usize or exceeds isize::MAX bytes

source

pub fn append_vec(&mut self, v: Vec<(K, V)>)

Appends a vector of key-value pairs onto the hashvec.

Internally, this uses HashVec::push(), which means that redundant keys’ entries will be overwritten and moved to the end of the hashvec sequentially.

source

pub fn swap_keys(&mut self, key_a: &K, key_b: &K)

Swaps the location of the provided keys’ entries

If either one of the keys is not already in the hashvec, this is a no-op.

source

pub fn swap_indices(&mut self, index_a: usize, index_b: usize)

Swaps the location of the entries at the provided indices

If either one of the indices exceeds the current length of the hashvec, this is a no-op.

source

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

Returns true if the hashvec contains an entry corresponding to the provided key.

source

pub fn get(&self, k: &K) -> Option<&V>

Returns a reference to the value corresponding to the key, if it exists.

source

pub fn get_mut(&mut self, k: &K) -> Option<&mut V>

Returns a mutable reference to the value corresponding to the key, if it exists.

source

pub fn rename(&mut self, old_key: &K, new_key: K) -> Option<&V>

Changes an entry’s key, preserving and returning a reference to the associated value.

If the hashvec did not have an entry corresponding to the old key, None is returned.

source

pub fn remove_key_entry(&mut self, k: &K) -> Option<(K, V)>

Removes a key from the hashvec, returning the stored key and value if the key was previously in the hashvec.

source

pub fn index(&self, k: &K) -> Option<usize>

Returns the index of the provided key, if the key exists.

source

pub fn remove_key(&mut self, k: &K) -> Option<V>

Removes a key from the hashvec, returning the stored value if the key was previously in the hashvec.

source

pub fn reserve(&mut self, additional: usize)

Reserves capacity for at least additional more elements to be inserted in the HashVec. The collection may reserve more space to avoid frequent reallocations.