Struct stacko::Stacko

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

A Stacko for storing values of a single type.

Implementations

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

pub fn new() -> Self

Constructs an empty Stacko with a capacity of DEFAULT_CAPACITY.

pub fn with_capacity(capacity: usize) -> Self

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

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

Pushes a value onto the Stacko potentially allocating more memory.

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

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

Errors

Fails in case no space is available in the Stacko.

pub fn len(&self) -> usize

The number of values stored in the Stacko.

pub fn is_empty(&self) -> bool

Checks whether the Stacko 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 Stacko. It is O(log n) if the key cannot be found or it has been serialized and deserialized without also serializing and deserializing the Stacko.

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 Stacko 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 Stacko<T, K>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

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

fn from(stacko: Stacko<T, K>) -> Self

Performs the conversion.

impl<T, K: Key> From<Vec<T, Global>> for Stacko<T, K>

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

Performs the conversion.

impl<T, K: Key> FromIterator<T> for Stacko<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 Stacko<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 Stacko<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 Stacko<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 Stacko<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.