Struct rate_common::memory::StackMapping

pub struct StackMapping<Key: Offset + Copy + Debug, T: Copy + Debug> { /* fields omitted */ }

A combination of a BoundedVector and an Array.

This provides Vec-like semantics with elements of type Key. Additionally, each key is associated with one value of type T (key is mapped to value). The value can be looked up in constant time using the index operator ([]).

Methods

impl<Key: Offset + Copy + Debug, T: Copy + Debug> StackMapping<Key, T>

pub fn with_array_value_size_stack_size(
    array_value: T,
    array_size: usize,
    stack_size: usize
) -> StackMapping<Key, T>

Construct a new StackMapping.

Parameters

• array_value: see default_value
• array_size: the size of the array, must be large enough to hold the highest expected value of type Key
• stack_size: the maximum size of the stack, e.g. the maximum number of keys that can be added to this stackmapping

pub fn len(&self) -> usize

See Vec::len().

pub fn is_empty(&self) -> bool

See Vec::is_empty().

pub fn pop(&mut self) -> Option<Key>

This removs the top Key and also resets the mapping of this key to the default_value.

pub fn peek(&self) -> Key

Returns the last key in the vector.

Panics

Panics if the vector is empty.

pub fn clear(&mut self)

This clears the vector and resets all mappings.

pub fn stack_at(&self, offset: usize) -> Key

Returns the key in the vector at the given index.

pub fn stack_at_mut(&mut self, offset: usize) -> &mut Key

Returns the mutable key in the vector at the given index.

pub fn push(&mut self, key: Key, value: T)

Pushes to the vector and maps key to value.

pub fn push_but_do_not_set(&mut self, key: Key)

Pushes to the vector.

pub fn set_but_do_not_push(&mut self, key: Key, value: T)

Maps key to value.

pub fn iter(&self) -> Iter<Key>

Returns an iterator over the keys in the vector.

impl<Key: Ord + Offset + Copy + Debug, T: Copy + Debug> StackMapping<Key, T>

pub fn sort_unstable(&mut self)

See Vec::sort_unstable().

impl<Key: Offset + Copy + Debug, T: Copy + Debug> StackMapping<Key, T>

pub fn sort_unstable_by_key<F, K>(&mut self, f: F) where
    F: FnMut(&Key) -> K,
    K: Ord, 

See Vec::sort_unstable_by_key().

Trait Implementations

impl<Key: Offset + Copy + Debug, T: Copy + Debug> HeapSpace for StackMapping<Key, T>

fn heap_space(&self) -> usize

The number of bytes allocated on the heap that this owns.

impl<'a, Key: Offset + Copy + Debug, T: Copy + Debug> IntoIterator for &'a StackMapping<Key, T>

type Item = &'a Key

The type of the elements being iterated over.

type IntoIter = Iter<'a, Key>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<Key: Default + Offset + Copy + Debug, T: Default + Copy + Debug> Default for StackMapping<Key, T>

fn default() -> StackMapping<Key, T>

Returns the "default value" for a type.

impl<Key: Debug + Offset + Copy, T: Debug + Copy> Debug for StackMapping<Key, T>

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

Formats the value using the given formatter.

impl<Key: Offset + Copy + Debug, T: Copy + Debug> Index<Key> for StackMapping<Key, T>

type Output = T

The returned type after indexing.

fn index(&self, key: Key) -> &T

Performs the indexing (container[index]) operation.