Struct cjdns_sniff::CtrlMessage

pub struct CtrlMessage {
    pub msg_type: CtrlMessageType,
    pub msg_data: CtrlMessageData,
}

Serialized control message

Fields

msg_type: CtrlMessageType

msg_data: CtrlMessageData

Implementations

impl CtrlMessage

pub const HEADER_SIZE: usize

Control message header size, which is considered as minimum size message bytes to parsed. Actually, message size should be greater than is stated in this constant, but this is checked further in CtrlMessage "sub-parsers".

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

Parses raw bytes into CtrlMessage.

Result in error in several situations:

• input bytes length is less then CtrlMessage::HEADER_SIZE
• input data got invalid checksum
• unrecognized control message type code was parsed
• control message body parsing methods failed. For more information about this read documentation for corresponding message data structs (i.e. PingData, ErrorData)

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

Serializes CtrlMessage instance.

CtrlMessage type can be instantiated directly, without using parse method. That's why serialization can result in errors in several situations:

• instantiated message with different header and body types. For example, message with error type stated in header and ping data will fail serialization
• error/ping data serialization failed

pub fn get_error_data(&self) -> Option<&ErrorData>

pub fn get_ping_data(&self) -> Option<&PingData>

Trait Implementations

impl Clone for CtrlMessage

pub fn clone(&self) -> CtrlMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CtrlMessage

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

Formats the value using the given formatter.

impl Eq for CtrlMessage

impl PartialEq<CtrlMessage> for CtrlMessage

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

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

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

This method tests for !=.

impl StructuralEq for CtrlMessage

impl StructuralPartialEq for CtrlMessage