Struct binate::frame::codec::MetadataPushFrame

pub struct MetadataPushFrame { /* fields omitted */ }

This is supported on crate feature frame only.

The meatadata_push frame.

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

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

Implementations

impl MetadataPushFrame

pub const STREAM_ID: u32

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

pub const TYPE: FrameType

Type of this frame.

pub fn new(metadata: Bytes) -> Self

Create a MetadataPush frame.

pub fn metadata(&self) -> &Bytes

Returns the metadata attached to this frame, if any.

Trait Implementations

impl Clone for MetadataPushFrame

fn clone(&self) -> MetadataPushFrame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetadataPushFrame

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

Formats the value using the given formatter.

impl Decode for MetadataPushFrame

type Value = Self

The value decoded into.

fn decode<B: Buf>(
    buf: &mut B,
    _stream_id: u32,
    _flags: Flags
) -> Result<Self::Value, DecodeError>

Decodes the given bytes into a frame.

impl Encode for MetadataPushFrame

fn encode(&self, buf: &mut BytesMut)

Encodes self into bytes.

fn len(&self) -> usize

Returns the length (in bytes) of this value.

fn is_empty(&self) -> bool

Returns whether this value is empty.

fn to_bytes(&self) -> Bytes

Encodes self into bytes.

impl PartialEq<MetadataPushFrame> for MetadataPushFrame

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for MetadataPushFrame

impl StructuralEq for MetadataPushFrame

impl StructuralPartialEq for MetadataPushFrame