Enum binate::frame::FrameType

#[non_exhaustive]
pub enum FrameType {
    SETUP,
    LEASE,
    KEEPALIVE,
    REQUEST_RESPONSE,
    REQUEST_FNF,
    REQUEST_STREAM,
    REQUEST_CHANNEL,
    REQUEST_N,
    CANCEL,
    PAYLOAD,
    ERROR,
    METADATA_PUSH,
    RESUME,
    RESUME_OK,
    EXT,
}

This is supported on crate feature frame only.

Type of frame.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

SETUP

Sent by client to initiate protocol processing.

LEASE

Sent by Responder to grant the ability to send requests.

KEEPALIVE

Connection keepalive.

REQUEST_RESPONSE

Request single response.

REQUEST_FNF

A single one-way message.

REQUEST_STREAM

Request a completable stream.

REQUEST_CHANNEL

Request a completable stream in both directions.

REQUEST_N

Request N more items with Reactive Streams semantics.

CANCEL

Cancel outstanding request.

PAYLOAD

Payload on a stream. For example, response to a request, or message on a channel.

ERROR

Error at connection or application level.

METADATA_PUSH

Asynchronous Metadata frame

RESUME

Replaces SETUP for Resuming Operation (optional)

RESUME_OK

Sent in response to a RESUME if resuming operation possible (optional)

EXT

Used To Extend more frame types as well as extensions.

Implementations

impl FrameType

pub fn from_value(val: u16) -> Option<FrameType>

Specify the frame type with the raw value described in the Frame Types section of the RSocket protocol spec. This will return None if the given raw value is unrecognized.

pub fn from_bits(bits: u16) -> Option<FrameType>

Convert from underlying bit representation, if the bit representation contains a valid frame type.

In other words, the higher 6-bit of the given bit pattern will convert to a FrameType.

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
+-----------+-+-+-+-+-----------+-------------------------------+
|Frame Type |I|M|     Flags     |
+-----------+-+-+-+-+-----------+-------------------------------+

pub fn value(self) -> u16

Returns the corresponding raw value of this frame type. The raw value is described in the Frame Types section of the RSocket protocol spec.

pub fn bits(self) -> u16

Convert this frame type to a bit representation, with the higher 6-bit of the return value setting to the raw value of the frame type.

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
+-----------+-+-+-+-+-----------+-------------------------------+
|Frame Type |I|M|     Flags     |
+-----------+-+-+-+-+-----------+-------------------------------+

Trait Implementations

impl Clone for FrameType

fn clone(&self) -> FrameType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrameType

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

Formats the value using the given formatter.

impl PartialEq<FrameType> for FrameType

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

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

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

This method tests for !=.

impl Copy for FrameType

impl Eq for FrameType

impl StructuralEq for FrameType

impl StructuralPartialEq for FrameType