Skip to main content

MessageHeader

Struct MessageHeader 

Source
pub struct MessageHeader {
    pub session_id: SessionId,
    pub session_type: SessionType,
    pub privacy: bool,
    pub control: bool,
    pub message_counter: u32,
    pub source: Option<NodeId>,
    pub destination: Destination,
}
Expand description

The unencrypted header every Matter message starts with (§4.4.1).

Fields§

§session_id: SessionId

Which session — and so which key — this message belongs to.

§session_type: SessionType

Unicast or group.

§privacy: bool

Whether privacy processing (§4.9) was applied.

§control: bool

Whether this is a control message, which counts on its own counter (§4.8.1.1).

§message_counter: u32

The sender’s monotonically increasing counter for this key (§4.4.1.4).

§source: Option<NodeId>

The sender, when it chose to say (§4.4.1.5).

§destination: Destination

The recipient (§4.4.1.6).

Implementations§

Source§

impl MessageHeader

Source

pub const fn is_unsecured(&self) -> bool

Whether this is the unsecured session: unicast, session id zero (§4.4.1.3).

“The Unsecured Session SHALL have no encryption, privacy, or message integrity checking” — so a message on it carries no MIC.

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 rest of the message.

Trait Implementations§

Source§

impl Clone for MessageHeader

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 MessageHeader

Source§

impl Debug for MessageHeader

Source§

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

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

impl Default for MessageHeader

Source§

fn default() -> Self

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

impl Eq for MessageHeader

Source§

impl PartialEq for MessageHeader

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 MessageHeader

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.