Struct Payload 

pub struct Payload {
    pub metadata: BytesMut,
    pub data: BytesMut,
    /* private fields */
}

PAYLOAD Frame (0x0A)

Frame Contents

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                           Stream ID                           |
+-----------+-+-+-+-+-+---------+-------------------------------+
|Frame Type |0|M|F|C|N|  Flags  |
+-------------------------------+-------------------------------+
                     Metadata & Data

Valid combinations of (C)omplete and (N)ext flags are:

• Both (C)omplete and (N)ext set meaning PAYLOAD contains data and signals stream completion. For example: An Observable stream receiving onNext(payload) followed by onComplete().

• Just (C)omplete set meaning PAYLOAD contains no data and only signals stream completion. For example: An Observable stream receiving onComplete().

• Just (N)ext set meaning PAYLOAD contains data stream is NOT completed. For example: An Observable stream receiving onNext(payload).

A PAYLOAD MUST NOT have both (C)complete and (N)ext empty (false).

The reason for the (N)ext flag instead of just deriving from Data length being > 0 is that 0 length data can be considered a valid PAYLOAD resulting in a delivery to the application layer with a PAYLOAD containing 0 bytes of data.

For example: An Observable stream receiving data via onNext(payload) where payload contains 0 bytes of data.

Fields

metadata: BytesMut

Payload Metadata

data: BytesMut

Payload Data

Implementations

impl Payload

pub fn set_metadata(&mut self, metadata: BytesMut)

Sets the value of Payload.metadata

pub fn set_data(&mut self, data: BytesMut)

Sets the value of Payload.data

pub const fn builder() -> PayloadBuilder

Creates a builder to builder a frame of this type.

Trait Implementations

impl Clone for Payload

fn clone(&self) -> Payload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Payload

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

Formats the value using the given formatter.

impl Decoder for Payload

type Error = Error

The type of error that can occur if decoding fails.

fn decode(__buf: &mut BytesMut) -> Result<Self, Self::Error>

Decodes a value from the given buffer.

fn has_enough_bytes(_buf: &BytesMut) -> bool

Returns true if the given buffer can be decoded.

impl Encoder for Payload

type Error = Error

The type of error that can occur if encoding fails.

fn encode(input: &Self, __buf: &mut BytesMut) -> Result<(), Self::Error>

Encodes the given input into the output buffer.

fn size_of(input: &Self) -> usize

Returns the number of bytes required to encode the given input.

impl FrameVariant for Payload

const FLAGS_MASK: FrameFlags

Mask that flags of a variant must be in.

fn flags(&self) -> FrameFlags

Gets the flags of the variant.

const REQUIRED_FLAGS: FrameFlags = _

Flags that must be set for a variant.

impl From<Payload> for Frame

fn from(value: Payload) -> Self

Converts to this type from the input type.