Struct Frame 

pub struct Frame<'a> {
    pub message_type: u16,
    pub payload: &'a [u8],
}

One complete TCP frame borrowed from an input buffer.

Frame::message_type is the raw wire code; use TcpMessageType::try_from to resolve it to a known message. Frame::total_len is the number of bytes the caller should consume from the front of the buffer before parsing again.

Fields

message_type: u16

payload: &'a [u8]

Implementations

impl Frame<'_>

pub fn total_len(&self) -> usize

Total bytes this frame occupies on the wire (header plus payload). Never overflows: the payload length was bounded by MAX_PAYLOAD_LEN at parse.

Trait Implementations

impl<'a> Clone for Frame<'a>

fn clone(&self) -> Frame<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Frame<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for Frame<'a>

fn eq(&self, other: &Frame<'a>) -> 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<'a> Copy for Frame<'a>

impl<'a> Eq for Frame<'a>

impl<'a> StructuralPartialEq for Frame<'a>