Struct ratman_netmod::Frame

pub struct Frame {
    pub sender: Identity,
    pub recipient: Recipient,
    pub seq: SeqData,
    pub payload: Vec<u8>,
}

A sequence of data, represented by a single network packet

Because a Frame is usually created in a sequence, the constructors assume chainable operations, such as a Vec<Frame> can be returned with all sequence ID information correctly setup.

Fields

sender: Identity

Sender information

recipient: Recipient

Recipient information

seq: SeqData

Data sequence identifiers

payload: Vec<u8>

Raw data payload

Implementations

impl Frame

pub fn dummy() -> Self

Produce a new dummy frame that sends nonsense data from nowhere to everyone.

pub fn inline_flood(sender: Identity, payload: Vec<u8>) -> Frame

Build a one-off frame with inline payload

pub fn seqid(&self) -> SeqId

Return the sequence Id of a frame

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a copy of the value.

pub 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<'de> Deserialize<'de> for Frame

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<Frame> for Frame

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for Frame

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Frame