Struct cjdns_core::EncodingScheme

pub struct EncodingScheme(_);

Encoding scheme - an iterable list of scheme forms.

Schemes are comparable for equality, immutable, opaque and iterable.

Implementations

impl EncodingScheme

pub fn try_new(
    forms: &[EncodingSchemeForm]
) -> Result<Self, SchemeValidationError>

Instantiates EncodingScheme.

Returns an error if forms validation failed. See validate function docs for more info.

pub fn validate(
    forms: &[EncodingSchemeForm]
) -> Result<(), SchemeValidationError>

Validates encoding scheme.

Returns an error in several situations:

• provided forms slice length is 0 or greater than 31
• bit_count value of any form is out of valid range - 1..32
• prefix_len value of any form is out if valid range - 1..32 (for multiple forms scheme)
• forms are not in ascending order by bits_count key
• bits size of a form is greater than 59 (for multiple forms scheme)
• forms with equal prefixes are in scheme

Each returned value fully reflects error type.

Trait Implementations

impl Clone for EncodingScheme

fn clone(&self) -> EncodingScheme

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EncodingScheme

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

Formats the value using the given formatter.

impl Deref for EncodingScheme

type Target = [EncodingSchemeForm]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Eq for EncodingScheme

impl PartialEq<EncodingScheme> for EncodingScheme

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

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

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

This method tests for !=.

impl StructuralEq for EncodingScheme

impl StructuralPartialEq for EncodingScheme