Struct cjdns_hdr::RouteHeader

pub struct RouteHeader {
    pub public_key: Option<CJDNSPublicKey>,
    pub ip6: Option<CJDNS_IP6>,
    pub version: u32,
    pub switch_header: SwitchHeader,
    pub is_incoming: bool,
    pub is_ctrl: bool,
}

Deserialized route header struct.

public_key and ip6 are optional. That is because route header has same structure for both control and incoming frames. So if it is a control frame, then public_key and ip6 fields should both have None value. Sometimes public_key can be None for incoming frames, but in that case ip6 will always have some value. Otherwise, header is considered invalid and won't be serialized.

Fields

public_key: Option<CJDNSPublicKey>

ip6: Option<CJDNS_IP6>

version: u32

switch_header: SwitchHeader

is_incoming: bool

is_ctrl: bool

Implementations

impl RouteHeader

pub const SIZE: usize

Size of serialized RouteHeader

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

Parses raw bytes into RouteHeader struct.

Result in error in several situations:

• if input byte length isn't equal to RouteHeader::SIZE;
• if parsing provided switch header bytes ended up with an error;
• if ip6 bytes or public key bytes are invalid for ip6 initialization;
• if ip6 derived from public key isn't equal to ip6 created from input bytes;
• if "is_ctrl - public_key - ip6" invariant is not met;
• if flag for message type states not control, nor incoming frame.

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

Serialized RouteHeader instance.

RouteHeader type can be instantiated directly, without using parse method. That's why serialization can result in errors. For example, if invariants stated in parse method are not met or switch header serialization failed, then route header serialization ends up with an error.

Trait Implementations

impl Clone for RouteHeader

fn clone(&self) -> RouteHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RouteHeader

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

Formats the value using the given formatter.

impl Eq for RouteHeader

impl PartialEq<RouteHeader> for RouteHeader

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

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

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

This method tests for !=.

impl StructuralEq for RouteHeader

impl StructuralPartialEq for RouteHeader