Struct cjdns_hdr::SwitchHeader

pub struct SwitchHeader {
    pub label: RoutingLabel<u64>,
    pub congestion: u8,
    pub suppress_errors: bool,
    pub version: u8,
    pub label_shift: u8,
    pub penalty: u16,
}

Deserialized switch header struct.

Fields

label: RoutingLabel<u64>

congestion: u8

suppress_errors: bool

version: u8

label_shift: u8

penalty: u16

Implementations

impl SwitchHeader

pub const SIZE: usize

Size of serialized SwitchHeader

pub const CURRENT_VERSION: u8

Current version of SwitchHeader which is automatically set, if version is not specified (i.e. == 0) during serialization.

pub fn parse(data: &[u8]) -> Result<Self, ParseError>

Parses raw bytes into SwitchHeader struct.

Results in error in several situations:

• if parsed version value is neither 0 nor SwitchHeader::CURRENT_VERSION;
• if parsed label number is 0;
• if data input size != SwitchHeader::SIZE.

SwitchHeader bytes have a following structure: 8 bytes for routing label, one byte for congestion value and suppress error flag, also a byte for version and label shift values and 2 bytes for penalty value. Congestion value always takes 7 bits. Last bit of congestion byte is suppress error flag. Version value takes last 2 bits of a sharing with label shift value byte. First 6 bits of the byte "belong" to label_shift.

pub fn serialize(&self) -> Result<Vec<u8>, SerializeError>

Serializes SwitchHeader instance.

SwitchHeader type can be instantiated directly, without using parse method. That's why serialization can result in errors. If header version isn't equal to 0 or to SwitchHeader::CURRENT_VERSION, then serialization fails. Also serialization fails if label_shift value takes more than 6 bits (i.e. > 63), or if congestion value takes more than 7 bits (i.e. > 127).

If SwitchHeader was instantiated with 0 version, header will be parsed with version equal to SwitchHeader::CURRENT_VERSION.

Trait Implementations

impl Clone for SwitchHeader

fn clone(&self) -> SwitchHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SwitchHeader

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

Formats the value using the given formatter.

impl Eq for SwitchHeader

impl PartialEq<SwitchHeader> for SwitchHeader

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

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

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

This method tests for !=.

impl StructuralEq for SwitchHeader

impl StructuralPartialEq for SwitchHeader