Struct binate::frame::codec::RequestChannelFrame

pub struct RequestChannelFrame { /* fields omitted */ }

This is supported on crate feature frame only.

The request_channel frame.

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|  Flags    |
+-------------------------------+-------------------------------+
|0|                    Initial Request N                        |
+---------------------------------------------------------------+
                       Metadata & Request Data

Implementations

impl RequestChannelFrame

pub const TYPE: FrameType

Type of this frame.

pub fn new(
    stream_id: u32,
    follows: bool,
    complete: bool,
    initial_request_n: u32,
    payload: Payload
) -> Self

Create a new RequestChannel frame.

• stream_id MUST be <= MAX_U31.
• flag follows means more fragments follow this fragment.
• flag complete indicates stream completion. If set on_complete() or equivalent will be invoked on Subscriber/Observer.
• initial_request_n MUST be > 0 and <= MAX_U31.

pub fn stream_id(&self) -> u32

Returns the stream ID of this frame.

pub fn is_follows(&self) -> bool

Returns true if this frame has the FOLLOWS flag set.

pub fn is_complete(&self) -> bool

Returns true if this frame has the COMPLETE flag set.

pub fn initial_request_n(&self) -> u32

Returns the initial number of items to request.

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 attached to this frame.

Trait Implementations

impl Clone for RequestChannelFrame

fn clone(&self) -> RequestChannelFrame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RequestChannelFrame

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

Formats the value using the given formatter.

impl Decode for RequestChannelFrame

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 RequestChannelFrame

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

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

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

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

This method tests for !=.

impl Eq for RequestChannelFrame

impl StructuralEq for RequestChannelFrame

impl StructuralPartialEq for RequestChannelFrame