Skip to main content

Received

Enum Received 

Source
#[non_exhaustive]
pub enum Received<'a> { Group { session_id: SessionId, from: Peer, }, SessionClosed { session: SessionId, }, Message { exchange: ExchangeKey, header: ProtocolHeader, needs_ack: bool, payload: &'a [u8], }, Duplicate { exchange: ExchangeKey, needs_ack: bool, }, Acknowledged { exchange: ExchangeKey, }, }
Available on crate feature rustcrypto only.
Expand description

What arrived, once the message has been authenticated and routed.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Group

A group datagram (§4.16), which belongs to the group key store rather than here.

Nothing about it has been decrypted or authenticated: a group message is keyed by an operational group key, and which key it is has to be found by trying every installed one whose session id matches (§4.17.3.6). Hand buf — unchanged — to group::wire::receive, which does that and returns the payload; a node that holds no group keys drops it.

Fields

§session_id: SessionId

The Group Session Id from the header, which selects the candidate keys.

§from: Peer

Where it came from.

§

SessionClosed

The peer closed the session, and this node has done the same (§4.11.1.4).

The session, its keys and its exchanges are gone by the time this is returned — that is what “SHALL remove all state associated with the session” means, and it is done here rather than left to the caller because none of that state is the caller’s.

What is the caller’s is everything keyed on a session above this layer: §8.5’s subscriptions above all, which report on a session and have nowhere to go once it has gone, and the §5.5 commissioning channel, which a closed PASE session releases.

Fields

§session: SessionId

The session that was closed.

§

Message

A protocol message for the layer above.

Fields

§exchange: ExchangeKey

The exchange it belongs to.

§header: ProtocolHeader

The protocol header it carried.

§needs_ack: bool

Whether an acknowledgement is owed, which Messaging::acknowledge sends.

§payload: &'a [u8]

The application payload, decrypted in place.

§

Duplicate

An authenticated message this node has already seen (§4.12.2.2).

Not delivered upward. Still acknowledged, because the sender’s retransmission means its last acknowledgement was lost, not that its message was.

Fields

§exchange: ExchangeKey

The exchange it belongs to.

§needs_ack: bool

Whether an acknowledgement is owed.

§

Acknowledged

A standalone acknowledgement, consumed entirely by the reliability layer.

Fields

§exchange: ExchangeKey

The exchange it acknowledged.

Trait Implementations§

Source§

impl<'a> Debug for Received<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Forget for Received<'a>

§

impl<'a> Freeze for Received<'a>

§

impl<'a> Move for Received<'a>

§

impl<'a> RefUnwindSafe for Received<'a>

§

impl<'a> Send for Received<'a>

§

impl<'a> Sync for Received<'a>

§

impl<'a> Unpin for Received<'a>

§

impl<'a> UnsafeUnpin for Received<'a>

§

impl<'a> UnwindSafe for Received<'a>

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> 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, 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.