Skip to main content

Message

Struct Message 

Source
pub struct Message {
    pub v: u8,
    pub t: MessageType,
    pub id: u32,
    pub flags: u8,
    pub p: Vec<u8>,
}
Expand description

The message envelope sent over the wire.

Each message contains a version, type, correlation ID, flags, and a CBOR payload.

Wire format: [len: u32 BE][id: u32 BE][flags: u8][CBOR(v, t, p)]

The id and flags fields live in the binary frame header (outside CBOR) so that relay intermediaries can route frames without CBOR parsing.

Fields§

§v: u8

Protocol version.

§t: MessageType

Message type.

§id: u32

Correlation ID used to associate requests with responses and to identify exec sessions.

Serialized in the binary frame header, not in CBOR.

§flags: u8

Frame flags computed from the message type.

Serialized in the binary frame header, not in CBOR.

§p: Vec<u8>

The CBOR-encoded payload bytes.

Implementations§

Source§

impl Message

Source

pub fn new(t: MessageType, id: u32, p: Vec<u8>) -> Self

Creates a new message with the current protocol version and raw payload bytes.

Source

pub fn with_payload<T: Serialize>( t: MessageType, id: u32, payload: &T, ) -> ProtocolResult<Self>

Creates a new message by serializing the given payload to CBOR.

Source

pub fn payload<T: DeserializeOwned>(&self) -> ProtocolResult<T>

Deserializes the payload bytes into the given type.

Trait Implementations§

Source§

impl Clone for Message

Source§

fn clone(&self) -> Message

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Message

Source§

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

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

impl<'de> Deserialize<'de> for Message

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Message

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,