Struct penguin_mux::StreamFrame

#[repr(C)]
pub struct StreamFrame {
    pub sport: u16,
    pub dport: u16,
    pub flag: StreamFlag,
    pub data: Bytes,
}

Stream frame.

See PROTOCOL.md for details.

Fields

sport: u16

Source port (2 bytes)

dport: u16

Destination port (2 bytes)

flag: StreamFlag

Frame type (1 byte)

data: Bytes

Data

Implementations

impl StreamFrame

pub fn new_syn(dest_host: &[u8], dest_port: u16, sport: u16, rwnd: u64) -> Self

Create a new StreamFlag::Syn frame.

Arguments

• dest_host: The destination host to forward to.
• dest_port: The destination port to forward to.
• sport: The source port of this stream.
• rwnd: Number of frames buffered in the client receive buffer.

pub fn new_synack(sport: u16, dport: u16, rwnd: u64) -> Self

Create a new StreamFlag::SynAck frame.

Arguments

• sport: The source port of this stream.
• dport: The destination port of this stream (i.e. the source port of the Syn frame).
• rwnd: Number of frames buffered in the server receive buffer.

pub fn new_ack(sport: u16, dport: u16, psh_recvd_since: u64) -> Self

Create a new StreamFlag::Ack frame.

Arguments

• sport: The source port of this stream.
• dport: The destination port of this stream.
• psh_recvd_since: The number of Psh frames received since the previous Ack frame.

pub const fn new_rst(sport: u16, dport: u16) -> Self

Create a new StreamFlag::Rst frame.

Arguments

• sport: The destination port of the offending frame.
• dport: The source port of the offending frame.

pub const fn new_fin(sport: u16, dport: u16) -> Self

Create a new StreamFlag::Fin frame.

Arguments

• sport: The source port of this stream.
• dport: The destination port of this stream.

pub const fn new_psh(sport: u16, dport: u16, data: Bytes) -> Self

Create a new StreamFlag::Psh frame.

Arguments

• sport: The source port of this stream.
• dport: The destination port of this stream.
• data: The data to send.

Trait Implementations

impl Clone for StreamFrame

fn clone(&self) -> StreamFrame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StreamFrame

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

Formats the value using the given formatter.

impl From<StreamFrame> for Message

fn from(frame: StreamFrame) -> Self

Converts to this type from the input type.

impl From<StreamFrame> for Vec<u8>

fn from(frame: StreamFrame) -> Self

Convert a StreamFrame to bytes.

impl PartialEq for StreamFrame

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

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

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

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

impl TryFrom<Bytes> for StreamFrame

type Error = Error

The type returned in the event of a conversion error.

fn try_from(data: Bytes) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for StreamFrame

impl StructuralEq for StreamFrame

impl StructuralPartialEq for StreamFrame