Struct MetadataPush

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

METADATA_PUSH Frame (0x0C)

A Metadata Push frame can be used to send asynchronous metadata notifications from a Requester or Responder to its peer.

METADATA_PUSH frames MUST always use Stream ID 0 as they pertain to the Connection.

Metadata tied to a particular stream uses the individual Payload frame Metadata flag.

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 = 0                         |
+-----------+-+-+---------------+-------------------------------+
|Frame Type |0|1|     Flags     |
+-------------------------------+-------------------------------+
                            Metadata

Fields

metadata: BytesMut

Frame Metadata

This frame only supports Metadata, so the Metadata Length header MUST NOT be included.

Implementations

impl MetadataPush

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

Sets the value of MetadataPush.metadata

pub const fn builder() -> MetadataPushBuilder

Creates a builder to builder a frame of this type.

Trait Implementations

impl Clone for MetadataPush

fn clone(&self) -> MetadataPush

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetadataPush

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

Formats the value using the given formatter.

impl Decoder for MetadataPush

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 MetadataPush

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 MetadataPush

const FLAGS_MASK: FrameFlags

Mask that flags of a variant must be in.

const REQUIRED_FLAGS: FrameFlags

Flags that must be set for a variant.

fn flags(&self) -> FrameFlags

Gets the flags of the variant.

impl From<MetadataPush> for Frame

fn from(value: MetadataPush) -> Self

Converts to this type from the input type.