Struct binate::frame::codec::SetupFrame

pub struct SetupFrame { /* fields omitted */ }

This is supported on crate feature frame only.

The setup frame.

The SETUP frame is sent by the client to inform the server of the parameters under which it desires to operate.

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|M|R|L|  Flags    |
+-----------+-+-+-+-+-----------+-------------------------------+
|         Major Version         |        Minor Version          |
+-------------------------------+-------------------------------+
|0|                 Time Between KEEPALIVE Frames               |
+---------------------------------------------------------------+
|0|                       Max Lifetime                          |
+---------------------------------------------------------------+
|         Token Length          | Resume Identification Token  ...
+---------------+-----------------------------------------------+
|  MIME Length  |   Metadata Encoding MIME Type                ...
+---------------+-----------------------------------------------+
|  MIME Length  |     Data Encoding MIME Type                  ...
+---------------+-----------------------------------------------+
                    Metadata & Setup Payload

Implementations

impl SetupFrame

pub const STREAM_ID: u32

Setup frames MUST always use Stream ID 0 as they pertain to the connection.

pub const TYPE: FrameType

Type of this frame.

pub fn builder() -> SetupFrameBuilder

Returns a SetupFrameBuilder.

pub fn is_lease(&self) -> bool

Returns true if the flags have the LEASE bit set.

pub fn is_resume(&self) -> bool

Returns true if the flags have the RESUME bit set.

pub fn version(&self) -> Version

Returns the protocol version.

pub fn keepalive(&self) -> Duration

Returns the time between KEEPALIVE frames that the client will send.

pub fn lifetime(&self) -> Duration

Returns the time that a client will allow a server to not respond to a KEEPALIVE before it is assumed to be dead.

pub fn resume_token(&self) -> Option<&Bytes>

Returns the resume identification token (not present if the RESUME bit is not set).

pub fn metadata_mimetype(&self) -> Option<&str>

Returns the MIME type for encoding the medadata.

Note that this will always return None if metadata MIME type is not an ASCII string.

pub fn data_mimetype(&self) -> Option<&str>

Returns the MIME type for encoding the data.

Note that this will always return None if metadata MIME type is not an ASCII string.

pub fn metadata(&self) -> Option<&Bytes>

Returns the metadata attached to this frame, if any.

pub fn data(&self) -> Option<&Bytes>

Returns the data attached to this frame, if any.

pub fn payload(self) -> Payload

Returns the payload of this setup frame.

Trait Implementations

impl Clone for SetupFrame

fn clone(&self) -> SetupFrame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SetupFrame

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

Formats the value using the given formatter.

impl Decode for SetupFrame

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 SetupFrame

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<SetupFrame> for SetupFrame

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

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

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

This method tests for !=.

impl Eq for SetupFrame

impl StructuralEq for SetupFrame

impl StructuralPartialEq for SetupFrame