Struct Frame 

pub struct Frame {
    pub version: u8,
    pub frame_type: FrameType,
    pub channel_id: u32,
    pub seq: u64,
    pub payload: Vec<u8>,
}

One multiplex frame.

Fields

version: u8

frame_type: FrameType

channel_id: u32

seq: u64

For DATA: event sequence. For ACK/RESUME: the acknowledged / resume-after number.

payload: Vec<u8>

Implementations

impl Frame

pub fn open(channel_id: u32, payload: &OpenPayload) -> Result<Self, FrameError>

pub fn data( channel_id: u32, seq: u64, payload: Vec<u8>, ) -> Result<Self, FrameError>

pub fn ack(seq: u64) -> Self

pub fn resume(after: u64) -> Self

pub fn window(channel_id: u32, credit: u32) -> Self

pub fn ping(nonce: u64) -> Self

pub fn pong(nonce: u64) -> Self

pub fn goaway(code: u32) -> Self

pub fn close(channel_id: u32) -> Self

pub fn encode(&self) -> Result<Vec<u8>, FrameError>

Encode big-endian wire bytes.

pub fn decode(buf: &[u8]) -> Result<(Self, usize), FrameError>

Decode one frame from a complete buffer. Returns (frame, bytes_consumed).

pub fn parse_open(&self) -> Result<OpenPayload, FrameError>

pub fn journal_req(channel_id: u32, after: u64, limit: u32) -> Self

Journal request: seq = after, payload = u32 limit (big-endian).

pub fn journal_req_limit(&self) -> Option<u32>

pub fn journal_reply( channel_id: u32, body: &JournalReplyBody, ) -> Result<Self, FrameError>

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Self

Returns a duplicate 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 Eq for Frame

impl PartialEq for Frame

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Frame