Struct SubmessageHeader 

pub struct SubmessageHeader {
    pub submessage_id: SubmessageId,
    pub flags: u8,
    pub octets_to_next_header: u16,
}

Submessage-Header.

Fields

submessage_id: SubmessageId

ID of the submessage class.

flags: u8

Flag byte (bit 0 = E = little-endian body; further bits submessage-specific).

octets_to_next_header: u16

Body length in bytes. 0 has special meaning (see Spec §8.3.4.2): the reader reads “to the end of the datagram”.

Implementations

impl SubmessageHeader

pub const WIRE_SIZE: usize = 4

Wire-Size: 4 Bytes.

pub fn is_little_endian(self) -> bool

true if the E flag is set (LE body).

pub fn to_bytes(self) -> [u8; 4]

LE encoder. octets_to_next_header is written with the endianness given by is_little_endian() — the sub-header itself uses the same endianness as its body (Spec §8.3.4.1).

pub fn from_bytes(bytes: &[u8]) -> Result<Self, WireError>

Decodes a 4-byte slice.

Errors

UnexpectedEof, UnknownSubmessageId.

Trait Implementations

impl Clone for SubmessageHeader

fn clone(&self) -> SubmessageHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SubmessageHeader

impl Debug for SubmessageHeader

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

Formats the value using the given formatter.

impl Eq for SubmessageHeader

impl Hash for SubmessageHeader

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SubmessageHeader

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SubmessageHeader