Struct RequestChannel

pub struct RequestChannel {
    pub initial_request_n: u32,
    pub metadata: BytesMut,
    pub data: BytesMut,
    /* private fields */
}

REQUEST_CHANNEL Frame (0x07)

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

Note

• A requester MUST send only one REQUEST_CHANNEL frame. Subsequent messages from requester to responder MUST be sent as PAYLOAD frames.

• A requester MUST not send PAYLOAD frames after the REQUEST_CHANNEL frame until the responder sends a REQUEST_N frame granting credits for number of PAYLOADs able to be sent.

Fields

initial_request_n: u32

Initial Request N

Unsigned 31-bit integer representing the initial request N value for channel. Value MUST be > 0.

metadata: BytesMut

Request Metadata

Identification of the service being requested along with parameters for the request.

data: BytesMut

Request Data

Identification of the service being requested along with parameters for the request.

Implementations

impl RequestChannel

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

Sets the value of RequestChannel.metadata

pub const fn builder() -> RequestChannelBuilder

Creates a builder to builder a frame of this type.

Trait Implementations

impl Clone for RequestChannel

fn clone(&self) -> RequestChannel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RequestChannel

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

Formats the value using the given formatter.

impl Decoder for RequestChannel

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 RequestChannel

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 RequestChannel

const FLAGS_MASK: FrameFlags

Mask that flags of a variant must be in.

fn flags(&self) -> FrameFlags

Gets the flags of the variant.

const REQUIRED_FLAGS: FrameFlags = _

Flags that must be set for a variant.

impl From<RequestChannel> for Frame

fn from(value: RequestChannel) -> Self

Converts to this type from the input type.