Enum wasmrs_frames::Frame

pub enum Frame {
    PayloadFrame(PayloadFrame),
    Cancel(Cancel),
    ErrorFrame(ErrorFrame),
    RequestN(RequestN),
    RequestResponse(RequestResponse),
    RequestFnF(RequestFnF),
    RequestStream(RequestStream),
    RequestChannel(RequestChannel),
}

An enum that can hold any time of wasmrs frame.

Variants

PayloadFrame(PayloadFrame)

Cancel(Cancel)

ErrorFrame(ErrorFrame)

RequestN(RequestN)

RequestResponse(RequestResponse)

RequestFnF(RequestFnF)

RequestStream(RequestStream)

RequestChannel(RequestChannel)

Implementations

impl Frame

pub const FLAG_IGNORE: FrameFlags = 16u16

The IGNORE bit

pub const FLAG_NEXT: FrameFlags = 32u16

The NEXT bit

pub const FLAG_COMPLETE: FrameFlags = 64u16

The COMPLETE bit

pub const FLAG_FOLLOW: FrameFlags = 128u16

The FOLLOW bit

pub const FLAG_METADATA: FrameFlags = 256u16

The METADATA bit

pub const REQUEST_MAX: u32 = 2_147_483_647u32

The maximum number of N for RequestN

pub fn stream_id(&self) -> u32

Get the stream id for the frame.

pub fn get_flag(&self) -> FrameFlags

Get the set flags for the frame.

pub fn frame_type(&self) -> FrameType

Get the FrameType.

pub fn decode(bytes: Bytes) -> Result<Frame, (u32, Error)>

Decode Bytes into a Frame.

pub fn encode(self) -> Bytes

Encode the Frame into a byte buffer.

pub fn new_error(stream_id: u32, e: PayloadError) -> Frame

Create a new [ErrorFrame].

pub fn new_cancel(stream_id: u32) -> Frame

Create a new [Cancel] frame.

pub fn new_request_n(stream_id: u32, n: u32, _flags: FrameFlags) -> Frame

Create a new [RequestN] frame.

pub fn new_request_response( stream_id: u32, payload: RawPayload, flags: FrameFlags ) -> Frame

Create a new [RequestResponse] frame.

pub fn new_request_stream( stream_id: u32, payload: RawPayload, flags: FrameFlags ) -> Frame

Create a new [RequestStream] frame.

pub fn new_request_channel( stream_id: u32, payload: RawPayload, flags: FrameFlags, initial_n: u32 ) -> Frame

Create a new [RequestChannel] frame.

pub fn new_request_fnf( stream_id: u32, payload: RawPayload, flags: FrameFlags ) -> Frame

Create a new [RequestFnF] (Fire & Forget) frame

pub fn new_payload( stream_id: u32, payload: RawPayload, flags: FrameFlags ) -> Frame

Create a new [PayloadFrame].

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl From<Frame> for Result<Option<RawPayload>, PayloadError>

fn from(frame: Frame) -> Self

Converts to this type from the input type.