Struct cjdns_core::EncodingSchemeForm

pub struct EncodingSchemeForm { /* fields omitted */ }

A form of an encoding scheme. Form is used as follows to encode a director:

[     director     ] [     form.prefix     ]
^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^
form.bit_count bits   form.prefix_len bits

Implementations

impl EncodingSchemeForm

pub fn try_new(
    bit_count: u8,
    prefix_len: u8,
    prefix: u32
) -> Result<Self, FormValidationError>

Instantiates EncodingSchemeForm.

Returns an error in several situations:

• encoding bit_count value is out of valid range, which is 1..32
• prefix_len is too small for the provided prefix

pub fn params(&self) -> (u8, u8, u32)

Returns encoding scheme form params in respected order:

• bit count;
• prefix length;
• prefix itself.

pub fn size_bits(&self) -> u8

As a scheme is represented as an array of forms, this function will tell you how many bits of label space is occupied by a representation of a given form.

Trait Implementations

impl Clone for EncodingSchemeForm

fn clone(&self) -> EncodingSchemeForm

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for EncodingSchemeForm

impl Debug for EncodingSchemeForm

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

Formats the value using the given formatter.

impl Eq for EncodingSchemeForm

impl Ord for EncodingSchemeForm

fn cmp(&self, other: &EncodingSchemeForm) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<EncodingSchemeForm> for EncodingSchemeForm

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

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

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

This method tests for !=.

impl PartialOrd<EncodingSchemeForm> for EncodingSchemeForm

fn partial_cmp(&self, other: &EncodingSchemeForm) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &EncodingSchemeForm) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &EncodingSchemeForm) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &EncodingSchemeForm) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &EncodingSchemeForm) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for EncodingSchemeForm

impl StructuralPartialEq for EncodingSchemeForm