Struct MessageHeader 

pub struct MessageHeader {
    pub session_id: SessionId,
    pub stream_id: StreamId,
    pub sequence_nr: SerialNumber16,
    pub client_key: Option<ClientKey>,
}

XRCE Message-Header.

Fields

session_id: SessionId

Session identifier; decides whether client_key is present.

stream_id: StreamId

Stream identifier (best-effort/reliable/none).

sequence_nr: SerialNumber16

RFC-1982 16-bit serial number (little-endian on the wire).

client_key: Option<ClientKey>

Optional ClientKey — only when session_id <= 127.

Implementations

impl MessageHeader

pub const WIRE_SIZE_NO_KEY: usize = 4

Wire size without ClientKey: 4 bytes.

pub const WIRE_SIZE_WITH_KEY: usize

Wire size with ClientKey: 8 bytes.

pub fn without_client_key( session_id: SessionId, stream_id: StreamId, sequence_nr: SerialNumber16, ) -> Result<Self, XrceError>

Constructor without a ClientKey (session_id must be >=128).

Errors

ValueOutOfRange if session_id <= 127 — the header would then have to carry a ClientKey.

pub fn with_client_key( session_id: SessionId, stream_id: StreamId, sequence_nr: SerialNumber16, client_key: ClientKey, ) -> Result<Self, XrceError>

Constructor with a ClientKey (session_id must be <=127).

Errors

ValueOutOfRange if session_id >= 128.

pub fn wire_size(&self) -> usize

Wire size in bytes (4 or 8).

pub fn write_to(&self, out: &mut [u8]) -> Result<usize, XrceError>

Encodes the header into the given buffer and returns the number of bytes written.

Errors

WriteOverflow if out.len() < wire_size().

pub fn read_from(bytes: &[u8]) -> Result<(Self, usize), XrceError>

Decodes a header from a slice. Returns (header, bytes_consumed).

Errors

UnexpectedEof if bytes is too short for the variant chosen based on session_id.

Trait Implementations

impl Clone for MessageHeader

fn clone(&self) -> MessageHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MessageHeader

impl Debug for MessageHeader

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

Formats the value using the given formatter.

impl Default for MessageHeader

fn default() -> MessageHeader

Returns the “default value” for a type.

impl Eq for MessageHeader

impl Hash for MessageHeader

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 MessageHeader

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MessageHeader