Struct alice_protocol_reader::cdp_wrapper::cdp_array::CdpArray

pub struct CdpArray<T: RDH, const CAP: usize> { /* private fields */ }

The vector-like wrapper struct for CDPs

Implementations

impl<T: RDH, const CAP: usize> CdpArray<T, CAP>

pub fn new() -> Self

Construct a new, empty CdpArray<T: RDH>.

pub const fn new_const() -> Self

Construct a new, empty CdpArray<T: RDH> with at least the specified capacity.

The array will be able to hold at least capacity elements.

Examples

let mut arrvec = CdpArray::<RdhCru, 10>::new_const();
assert!(arrvec.len() == 0);

pub fn push(&mut self, rdh: T, payload: Vec<u8>, mem_pos: u64)

Appends an RDH, payload, and memory position to the back of the CdpArray

pub fn push_tuple(&mut self, cdp_tuple: (T, Vec<u8>, u64))

Convenience method to push a tuple of (RDH, payload, mem_pos)

Removes the need to destructure the tuple before pushing

pub fn len(&self) -> usize

Get the length of the CdpArray, corresponding to the number of CDPs

pub fn is_empty(&self) -> bool

Check if the CdpArray is empty

pub fn clear(&mut self)

Clear the CdpArray, removing all elements.

pub fn rdh_slice(&self) -> &[T]

Get a borrowed slice of the RDHs

pub fn rdh_mem_pos_slice(&self) -> &[u64]

Get a borrowed slice of the memory positions

pub fn iter(&self) -> CdpArrayIter<'_, T, CAP>

Create an iterator over the CdpArray that yields borrowed references to the CDPs

Trait Implementations

impl<T: Clone + RDH, const CAP: usize> Clone for CdpArray<T, CAP>

fn clone(&self) -> CdpArray<T, CAP>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + RDH, const CAP: usize> Debug for CdpArray<T, CAP>

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

Formats the value using the given formatter.

impl<T: RDH, const CAP: usize> Default for CdpArray<T, CAP>

fn default() -> Self

Returns the “default value” for a type.

impl<'a, T: RDH, const CAP: usize> IntoIterator for &'a CdpArray<T, CAP>

Implementation of a non-consuming iterator for CdpArray, with a helper struct

type Item = (&'a T, &'a [u8], u64)

The type of the elements being iterated over.

type IntoIter = CdpArrayIter<'a, T, CAP>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: RDH, const CAP: usize> IntoIterator for CdpArray<T, CAP>

Implementation of a consuming iterator for CdpArray, with a helper struct

type Item = (T, Vec<u8>, u64)

The type of the elements being iterated over.

type IntoIter = IntoIterHelper<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 + RDH, const CAP: usize> PartialEq for CdpArray<T, CAP>

fn eq(&self, other: &CdpArray<T, CAP>) -> 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: RDH, const CAP: usize> StructuralPartialEq for CdpArray<T, CAP>