Struct Frame

pub struct Frame<M = Message> {
    pub version: Version,
    pub stream: StreamId,
    pub data: FrameData<M>,
}

Protocol frame.

 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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|      'r'      |      'a'      |      'd'      |      0x1      | Version
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                     Stream ID                           |TTT|I| Stream ID with Stream [T]ype and [I]nitiator bits
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                     Data                                   ...| Data (variable size)
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Fields

version: Version

The protocol version.

stream: StreamId

The stream identifier.

data: FrameData<M>

The frame payload.

Implementations

impl<M> Frame<M>

pub fn git(stream: StreamId, data: Vec<u8>) -> Frame<M>

Create a ‘git’ protocol frame.

pub fn control(link: Link, ctrl: Control) -> Frame<M>

Create a ‘control’ protocol frame.

pub fn gossip(link: Link, msg: M) -> Frame<M>

Create a ‘gossip’ protocol frame.

impl<M> Frame<M>

where M: Encode,

pub fn to_bytes(&self) -> Vec<u8>

Serialize frame to bytes.

Trait Implementations

impl<M> Debug for Frame<M>

where M: Debug,

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

Formats the value using the given formatter.

impl<M> Decode for Frame<M>

where M: Decode,

fn decode(buf: &mut impl Buf) -> Result<Frame<M>, Error>

impl<M> Encode for Frame<M>

where M: Encode,

fn encode(&self, buf: &mut impl BufMut)

impl<M> PartialEq for Frame<M>

where M: PartialEq,

fn eq(&self, other: &Frame<M>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<M> Eq for Frame<M>

where M: Eq,

impl<M> StructuralPartialEq for Frame<M>