Struct socketio_rs::Packet

pub struct Packet {
    pub ptype: PacketType,
    pub nsp: String,
    pub data: Option<Value>,
    pub id: Option<usize>,
    pub attachment_count: u8,
    pub attachments: Option<Vec<Bytes>>,
}

A packet which gets sent or received during in the socket.io protocol.

Fields

ptype: PacketType

nsp: String

data: Option<Value>

id: Option<usize>

attachment_count: u8

attachments: Option<Vec<Bytes>>

Implementations

impl Packet

pub const fn new(
    ptype: PacketType,
    nsp: String,
    data: Option<Value>,
    id: Option<usize>,
    attachment_count: u8,
    attachments: Option<Vec<Bytes>>
) -> Self

Creates an instance.

Trait Implementations

impl Clone for Packet

fn clone(&self) -> Packet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Packet

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

Formats the value using the given formatter.

impl Default for Packet

fn default() -> Self

Returns the “default value” for a type.

impl From<&Packet> for Bytes

fn from(packet: &Packet) -> Bytes

Method for encoding from a Packet to a u8 byte stream. The binary payload of a packet is not put at the end of the stream as it gets handled and send by it’s own logic via the socket.

impl From<Packet> for Bytes

fn from(packet: Packet) -> Self

Converts to this type from the input type.

impl PartialEq<Packet> for Packet

fn eq(&self, other: &Packet) -> 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 Packet

fn try_from(payload: &Bytes) -> Result<Packet>

Decodes a packet given a Bytes type. The binary payload of a packet is not put at the end of the stream as it gets handled and send by it’s own logic via the socket. Therefore this method does not return the correct value for the binary data, instead the socket is responsible for handling this member. This is done because the attachment is usually send in another packet.

type Error = Error

The type returned in the event of a conversion error.

impl TryFrom<Bytes> for Packet

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Bytes) -> Result<Self>

Performs the conversion.

impl Eq for Packet

impl StructuralEq for Packet

impl StructuralPartialEq for Packet