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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                       |T T T I| Stream ID
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                              …| Data (variable size)
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Note that the last four bits of the Stream ID encode the Stream Type and Initiator. The first three bits of the last four bits encode the Stream Type, while the last bit encodes the Initiator.

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>) -> Self

Create a ‘git’ protocol frame.

pub fn control(link: Link, ctrl: Control) -> Self

Create a ‘control’ protocol frame.

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

Create a ‘gossip’ protocol frame.

Trait Implementations

impl<M: Debug> Debug for Frame<M>

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

Formats the value using the given formatter.

impl<M: Decode> Decode for Frame<M>

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

impl<M: Encode> Encode for Frame<M>

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

Encode self by writing it to the given buffer.

fn encode_to_vec(&self) -> Vec<u8>

A convenience wrapper around Encode::encode that allocates a Vec.

impl<M: Eq> Eq for Frame<M>

impl<M: PartialEq> PartialEq for Frame<M>

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

Equality operator ==.

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

Inequality operator !=.

impl<M: PartialEq> StructuralPartialEq for Frame<M>