Struct Code 

pub struct Code {
    pub content: u32,
    pub len: u32,
}

Represents a codeword.

Fields

content: u32

Concatenated fragments of the codeword.

If the code is too short to take up all the bits, only the least significant ones are used. The first fragments of the code are stored either on the most significant or, in the case of an reversed code, on the least significant, of these bits.

If the code is too long, only the last few fragments are explicitly stored. Fragments that do not fit contain zeros and are not explicitly stored.

len: u32

Length of the code in fragments.

Implementations

impl Code

pub unsafe fn get_rev_unchecked( &self, fragment_nr: u32, degree: impl TreeDegree, ) -> u32

Gets fragment_nr-th fragment from either the end or, if self is reversed, the beginning.

Result is undefined if fragment_nr is out of bounds (i.e. not less than len).

pub fn get_rev(&self, fragment_nr: u32, degree: impl TreeDegree) -> Option<u32>

Gets fragment_nr-th fragment from either the end or, if self is reversed, the beginning.

Returns None if fragment_nr is out of bounds (i.e. not less than len).

pub unsafe fn get_unchecked( &self, fragment_nr: u32, degree: impl TreeDegree, ) -> u32

Gets fragment_nr-th fragment from either the beginning or, if self is reversed, the end.

Result is undefined if fragment_nr is out of bounds (i.e. not less than len).

pub fn get(&self, fragment_nr: u32, degree: impl TreeDegree) -> Option<u32>

Gets fragment_nr-th fragment from either the beginning or, if self is reversed, the end.

Returns None if fragment_nr is out of bounds (i.e. not less than len).

pub fn extract_first(&mut self, degree: impl TreeDegree) -> Option<u32>

Extracts and returns the first remaining fragment of the unreversed code.

Return None if code is empty.

pub fn extract_rev_first(&mut self, degree: impl TreeDegree) -> Option<u32>

Extracts and returns the first remaining fragment of the reversed code.

Return None if code is empty.

pub fn is_empty(&self) -> bool

Returns whether self consists of zero fragments.

pub fn iter<D: TreeDegree>(&self, degree: D) -> CodeIterator<D>

Returns iterator over the fragments of unreversed code.

pub fn iter_rev<D: TreeDegree>(&self, degree: D) -> ReversedCodeIterator<D>

Returns iterator over the fragments of reversed code.

Trait Implementations

impl Clone for Code

fn clone(&self) -> Code

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Code

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

Formats the value using the given formatter.

impl Default for Code

fn default() -> Code

Returns the “default value” for a type.

impl PartialEq for Code

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for Code

impl Eq for Code

impl StructuralPartialEq for Code