Struct SharedVec

pub struct SharedVec<T, K: Key = DefaultKey> { /* private fields */ }

A SharedVec for storing values of a single type.

Implementations

impl<T, K: Key> SharedVec<T, K>

pub fn new() -> Self

Constructs an empty SharedVec with a capacity of DEFAULT_CAPACITY.

pub fn with_capacity(capacity: usize) -> Self

Constructs an empty SharedVec able to store at least capacity values before needing to allocate.

pub fn push(&self, value: T) -> (K, &T)

Pushes a value onto the SharedVec potentially allocating more memory.

pub fn push_with<F: FnOnce(K) -> T>(&self, func: F) -> (K, &T)

Pushes a value produced by func onto the SharedVec potentially allocating more memory.

This method takes a function which is provided with the key where the value will be stored and produces the value to be stored. It allows storing the key of a value inside the value itself.

Panics

May panic if the provided function accesses the SharedVec in any way.

pub fn try_push(&self, value: T) -> Result<(K, &T), T>

Tries to push a value onto the SharedVec without allocating more memory.

Errors

Fails in case no space is available in the SharedVec.

pub fn try_push_with<F: FnOnce(K) -> T>(&self, func: F) -> Result<(K, &T), F>

Same as push_with but without allocating more memory.

See push_with and try_push.

pub fn len(&self) -> usize

The number of values stored in the SharedVec.

pub fn is_empty(&self) -> bool

Checks whether the SharedVec is empty.

pub fn get(&self, key: K) -> Option<&T>

Returns a shared reference to the value stored for the given key.

The complexity is O(1) if the key has been returned by this SharedVec. It is O(log n) if the key cannot be found or it has been serialized and deserialized without also serializing and deserializing the SharedVec.

pub fn get_mut(&mut self, key: K) -> Option<&mut T>

Returns an exclusive reference to the value stored for the given key.

For details see get.

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

Returns a key corresponding to the provided index if a value is stored at the given index.

The complexity is O(log n).

pub fn into_vec(self) -> Vec<T>

Turns the SharedVec into a Vec.

The index of Key can be used as an index into the returned Vec.

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

Returns an Iterator over the stored key-value pairs.

Trait Implementations

impl<T: Clone, K: Clone + Key> Clone for SharedVec<T, K>

fn clone(&self) -> SharedVec<T, K>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, K: Debug + Key> Debug for SharedVec<T, K>

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

Formats the value using the given formatter.

impl<T, K: Key> Default for SharedVec<T, K>

fn default() -> Self

Returns the “default value” for a type.

impl<T, K: Key> From<SharedVec<T, K>> for Vec<T>

fn from(sharedvec: SharedVec<T, K>) -> Self

Converts to this type from the input type.

impl<T, K: Key> From<Vec<T>> for SharedVec<T, K>

fn from(chunk: Vec<T>) -> Self

Converts to this type from the input type.

impl<T, K: Key> FromIterator<T> for SharedVec<T, K>

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl<T, K: Key> Index<K> for SharedVec<T, K>

type Output = T

The returned type after indexing.

fn index(&self, key: K) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T, K: Key> IndexMut<K> for SharedVec<T, K>

fn index_mut(&mut self, key: K) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<'p, T, K: Key> IntoIterator for &'p SharedVec<T, K>

type Item = (K, &'p T)

The type of the elements being iterated over.

type IntoIter = Iter<'p, T, K>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T, K: Key> IntoIterator for SharedVec<T, K>

type Item = (K, T)

The type of the elements being iterated over.

type IntoIter = IntoIter<T, K>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.