Struct peapod::Peapod

pub struct Peapod<T: Phenotype> { /* private fields */ }

A vec-like data structure for compactly storing enums that implement Phenotype.

Implementations

impl<T> Peapod<T>where
    T: Phenotype,

pub fn new() -> Self

Create a new Peapod with 0 capacity and 0 length. This does not allocate.

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

Append a new element to the end of the collection.

Panics

Panics if the underlying bitvec or Vec panics. The underlying Vec will panic if its allocation exceeds isize::MAX bytes. The underlying bitvec will panic if the maximum tag capacity is exceeded. On 32-bit systems, maximum tag capacity is 0x1fff_ffff/T::BITS tags. On 64-bit systems, maximum tag capacity is 0x1fff_ffff_ffff_ffff/T::BITS tags.

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

Remove an element from the end of the collection. Returns None if the collection is empty.

pub fn len(&self) -> usize

Returns the number of elements in the collection.

pub fn is_empty(&self) -> bool

Returns the number of elements in the collection.

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

Returns whether the collection is empty (it contains no elements).

pub fn with_capacity(capacity: usize) -> Self

Creates a new peapod with enough space to add capacity elements without reallocating.

pub fn clear(&mut self)

Removes all elements from the collection. Note: this does not affect its allocated capacity.

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

Shortens the collection so it only contains the first len elements. Note: this does not affect its allocated capacity.

pub fn capacity(&self) -> usize

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

pub fn append(&mut self, other: Peapod<T>)

Adds other to the end of self, so the new collection now contains all the elements of self followed by the elements of other.

Trait Implementations

impl<T> Clone for Peapod<T>where
    T: Phenotype,
    T::Value: Clone,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Peapod<T>where
    T: Phenotype,

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

Formats the value using the given formatter.

impl<T> Default for Peapod<T>where
    T: Phenotype,

fn default() -> Self

Returns the “default value” for a type.

impl<T> Display for Peapod<T>where
    T: Phenotype,

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

Formats the value using the given formatter.

impl<T> Drop for Peapod<T>where
    T: Phenotype,

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Extend<T> for Peapod<T>where
    T: Phenotype,

fn extend<A: IntoIterator<Item = T>>(&mut self, iter: A)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<T> From<Peapod<T>> for Vec<T>where
    T: Phenotype,

fn from(pp: Peapod<T>) -> Self

Converts to this type from the input type.

impl<T> From<Vec<T, Global>> for Peapod<T>where
    T: Phenotype,

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

Converts to this type from the input type.

impl<T> FromIterator<T> for Peapod<T>where
    T: Phenotype,

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

Creates a value from an iterator.

impl<T> IntoIterator for Peapod<T>where
    T: Phenotype,

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> PartialEq<Peapod<T>> for Peapod<T>where
    T: Phenotype,
    T::Value: PartialEq,

fn eq(&self, other: &Self) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Eq + Phenotype> Eq for Peapod<T>where
    T::Value: Eq,

impl<T: Phenotype> StructuralEq for Peapod<T>