Envelope

Struct Envelope 

Source
pub struct Envelope<T> {
    pub seq: u64,
    pub ack: Option<u64>,
    pub timestamp: u64,
    pub payload: T,
}
Expand description

Message envelope wrapping any payload with delivery metadata.

Used for reliable message delivery with:

  • Sequence numbers for ordering
  • Acknowledgments for delivery confirmation
  • Timestamps for latency measurement and clock sync

Fields§

§seq: u64

Monotonically increasing sequence number (per connection). Server and client maintain separate sequences.

§ack: Option<u64>

Piggyback acknowledgment of the last received sequence number. Allows confirming receipt without a separate ack message.

§timestamp: u64

Server timestamp in milliseconds since Unix epoch. Clients can use this for latency calculation and clock sync.

§payload: T

The actual message payload.

Implementations§

Source§

impl<T> Envelope<T>

Source

pub fn new(seq: u64, payload: T) -> Self

Create a new envelope with the given sequence number and payload.

Source

pub fn with_ack(seq: u64, ack: u64, payload: T) -> Self

Create an envelope with a piggyback acknowledgment.

Source§

impl<T> Envelope<T>
where T: Clone,

Source

pub fn map<U, F>(self, f: F) -> Envelope<U>
where F: FnOnce(T) -> U,

Transform the payload while preserving envelope metadata.

Trait Implementations§

Source§

impl<T: Clone> Clone for Envelope<T>

Source§

fn clone(&self) -> Envelope<T>

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<T: Debug> Debug for Envelope<T>

Source§

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

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

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

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<T> Serialize for Envelope<T>
where T: Serialize,

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§

§

impl<T> Freeze for Envelope<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Envelope<T>
where T: RefUnwindSafe,

§

impl<T> Send for Envelope<T>
where T: Send,

§

impl<T> Sync for Envelope<T>
where T: Sync,

§

impl<T> Unpin for Envelope<T>
where T: Unpin,

§

impl<T> UnwindSafe for Envelope<T>
where T: 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.
Source§

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