Struct Packet

pub struct Packet<'a> {
    pub stream_id: u32,
    pub packet_type: PacketType<'a>,
}

Wisp protocol packet.

Fields

stream_id: u32

Stream this packet is associated with.

packet_type: PacketType<'a>

Packet type recieved.

Implementations

impl<'a> Packet<'a>

pub fn new(stream_id: u32, packet: PacketType<'a>) -> Self

Create a new packet.

The helper functions should be used for most use cases.

pub fn new_connect( stream_id: u32, stream_type: StreamType, destination_port: u16, destination_hostname: String, ) -> Self

Create a new connect packet.

pub fn new_data(stream_id: u32, data: Payload<'a>) -> Self

Create a new data packet.

pub fn new_continue(stream_id: u32, buffer_remaining: u32) -> Self

Create a new continue packet.

pub fn new_close(stream_id: u32, reason: CloseReason) -> Self

Create a new close packet.

Trait Implementations

impl<'a> Clone for Packet<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Packet<'a>

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

Formats the value using the given formatter.

impl From<Packet<'_>> for BytesMut

fn from(packet: Packet<'_>) -> Self

Converts to this type from the input type.

impl From<Packet<'_>> for Frame<'static>

fn from(packet: Packet<'_>) -> Self

Converts to this type from the input type.

impl<'a> TryFrom<Frame<'a>> for Packet<'a>

type Error = WispError

The type returned in the event of a conversion error.

fn try_from(frame: Frame<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Payload<'a>> for Packet<'a>

type Error = WispError

The type returned in the event of a conversion error.

fn try_from(bytes: Payload<'a>) -> Result<Self, Self::Error>

Performs the conversion.