Struct rate_common::memory::BoundedVector

pub struct BoundedVector<T> where
    T: HeapSpace,  { /* fields omitted */ }

A contiguous but non-growable array type, using Vector

This exposes a subset of the Vector API (and thus essentially behaves like a std::vec::Vec). Notably, it does not provide functions that grow the capacity of the vector.

A BoundedVector can be used as a stack with a known maximum size.

Methods

impl<T: HeapSpace> BoundedVector<T>

pub fn with_capacity(capacity: usize) -> BoundedVector<T>

See Vec::with_capacity().

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

Pushes a value, increasing the vector's length by one.

Note that unlike [Vec::push()`](https://doc.rust-lang.org/std/vec/struct.Vec.html#method.push) this does not grow the vector if it is full.

Panics

Panics if there is no space for the new element.

pub fn len(&self) -> usize

See Vec::len().

pub fn is_empty(&self) -> bool

See Vec::is_empty().

pub fn capacity(&self) -> usize

See Vec::capacity().

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

See Vec::pop().

pub fn first(&self) -> &T

See Vec::first().

pub fn last(&self) -> &T

See Vec::last().

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

See Vec::iter().

pub fn as_ptr(&mut self) -> *const T

See Vec::as_ptr().

pub fn mut_ptr(&mut self) -> *mut T

See Vec::mut_ptr().

pub fn truncate(&mut self, new_length: usize)

See Vec::truncate().

pub fn clear(&mut self)

See Vec::clear().

impl<T: HeapSpace + Clone + Default> BoundedVector<T>

pub fn resize(&mut self, new_length: usize)

See Vec::resize().

impl<T: HeapSpace + Ord> BoundedVector<T>

pub fn sort_unstable(&mut self)

See Vec::sort_unstable().

impl<T: HeapSpace> BoundedVector<T>

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

See Vec::sort_unstable_by_key().

Trait Implementations

impl<T> HeapSpace for BoundedVector<T> where
    T: HeapSpace, 

fn heap_space(&self) -> usize

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

impl<T: Default> Default for BoundedVector<T> where
    T: HeapSpace, 

fn default() -> BoundedVector<T>

Returns the "default value" for a type.

impl<T: Clone> Clone for BoundedVector<T> where
    T: HeapSpace, 

fn clone(&self) -> BoundedVector<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: PartialEq> PartialEq<BoundedVector<T>> for BoundedVector<T> where
    T: HeapSpace, 

fn eq(&self, other: &BoundedVector<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &BoundedVector<T>) -> bool

This method tests for !=.

impl<'a, T: HeapSpace> IntoIterator for &'a BoundedVector<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: HeapSpace> Index<usize> for BoundedVector<T>

type Output = T

The returned type after indexing.

fn index(&self, offset: usize) -> &T

Performs the indexing (container[index]) operation.

impl<T: HeapSpace> IndexMut<usize> for BoundedVector<T>

fn index_mut(&mut self, offset: usize) -> &mut T

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

impl<T: Debug> Debug for BoundedVector<T> where
    T: HeapSpace, 

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

Formats the value using the given formatter.