Struct Envelope 

pub struct Envelope {
    pub kind: u32,
    pub flags: u32,
    pub generation: u64,
    pub sequence: u64,
    /* private fields */
}

Caller-provided metadata for a newly encoded message.

Fields

kind: u32

Numeric message kind; interpretation belongs to the protocol.

flags: u32

Numeric flags; unknown required bits must be rejected by the protocol.

generation: u64

Nonzero connection generation.

sequence: u64

Nonzero per-direction sequence.

Implementations

impl Envelope

pub const fn new(kind: u32, flags: u32, generation: u64, sequence: u64) -> Self

Creates envelope metadata. The encoder fills the payload length.

Examples found in repository

examples/bounded_codec.rs (line 40)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut wire = [0_u8; 128];
    let written = encode_message::<CounterProtocol>(Envelope::new(1, 0, 7, 1), &42, &mut wire)?;

    let limits = Limits::new(128, 16, 1, 16);
    let decoded = decode_message::<CounterProtocol>(&wire[..written], &limits)?;

    assert_eq!(decoded.message, 42);
    assert_eq!(decoded.envelope.generation, 7);
    println!(
        "decoded counter {} from {} bounded bytes",
        decoded.message, written
    );
    Ok(())
}

pub const fn payload_len(self) -> u32

Returns the encoded payload size.

pub fn total_len(self) -> Result<usize, EncodeError>

Returns the total encoded size after checked conversion.

Trait Implementations

impl Clone for Envelope

fn clone(&self) -> Envelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Envelope

impl Debug for Envelope

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

Formats the value using the given formatter.

impl Eq for Envelope

impl PartialEq for Envelope

fn eq(&self, other: &Envelope) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Envelope