Skip to main content

Message

Struct Message 

Source
pub struct Message<P: Payload> { /* private fields */ }
Expand description

A message with a generic payload P.

Implementations§

Source§

impl<P: Payload> Message<P>

Source

pub fn new(header: MessageHeader, payload: P) -> Self

Construct a new message from a header and payload, fixing size and class.

Source

pub fn with_payload<Q: Payload>(self, payload: Q) -> Message<Q>

Swap payloads while recalculating header fields.

Source

pub fn map_payload<Q: Payload>(self, f: impl FnOnce(P) -> Q) -> Message<Q>

Transform payloads while preserving header metadata correctly.

Source

pub fn payload(&self) -> &P

Borrow the payload.

Source

pub fn payload_mut(&mut self) -> &mut P

Mutable borrow of the payload.

Source

pub fn header(&self) -> &MessageHeader

Borrow the header.

Source

pub fn header_mut(&mut self) -> &mut MessageHeader

Mutable borrow of the header.

Source

pub fn into_parts(self) -> (MessageHeader, P)

Decompose into (header, payload).

Trait Implementations§

Source§

impl<P: Clone + Payload> Clone for Message<P>

Source§

fn clone(&self) -> Message<P>

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<P: Debug + Payload> Debug for Message<P>

Source§

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

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

impl<P: Payload + Clone + Default> Default for Message<P>

Source§

fn default() -> Self

Default Message<P> constructed from an empty header and P::default().

Source§

impl<'a, P: Payload + 'a> Payload for &'a Message<P>

Source§

fn buffer_descriptor(&self) -> BufferDescriptor

Return a descriptor containing the byte size of this payload.
Source§

impl<P: Payload> Payload for Message<P>

Source§

fn buffer_descriptor(&self) -> BufferDescriptor

Return a descriptor containing the byte size of this payload.
Source§

impl<P> Copy for Message<P>
where P: Payload + Copy,

Auto Trait Implementations§

§

impl<P> Freeze for Message<P>
where P: Freeze,

§

impl<P> RefUnwindSafe for Message<P>
where P: RefUnwindSafe,

§

impl<P> Send for Message<P>
where P: Send,

§

impl<P> Sync for Message<P>
where P: Sync,

§

impl<P> Unpin for Message<P>
where P: Unpin,

§

impl<P> UnsafeUnpin for Message<P>
where P: UnsafeUnpin,

§

impl<P> UnwindSafe for Message<P>
where P: UnwindSafe,

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.