Skip to main content

ProtocolHeader

Struct ProtocolHeader 

Source
pub struct ProtocolHeader {
    pub initiator: bool,
    pub acknowledged_counter: Option<u32>,
    pub reliability: bool,
    pub exchange_id: ExchangeId,
    pub protocol: ProtocolId,
    pub opcode: u8,
}
Expand description

The header at the start of a message’s payload (§4.4.3).

Fields§

§initiator: bool

Whether this message came from the exchange’s initiator.

§acknowledged_counter: Option<u32>

The counter this message acknowledges, when it acknowledges one (§4.12.1).

§reliability: bool

Whether the sender wants an acknowledgement — the MRP R flag.

§exchange_id: ExchangeId

Which conversation this message belongs to.

§protocol: ProtocolId

Which protocol, and whose.

§opcode: u8

What kind of message, within that protocol.

Implementations§

Source§

impl ProtocolHeader

Source

pub const fn encoded_len(&self) -> usize

How many octets this header occupies.

Source

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

Writes the header into out, returning how many octets it used.

Source

pub fn decode(buf: &[u8]) -> Result<(Self, &[u8])>

Reads a header from the front of buf, returning it and the application payload.

Trait Implementations§

Source§

impl Clone for ProtocolHeader

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ProtocolHeader

Source§

impl Debug for ProtocolHeader

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ProtocolHeader

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for ProtocolHeader

Source§

impl PartialEq for ProtocolHeader

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ProtocolHeader

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.