Struct Packet

pub struct Packet {
    pub inner: PacketData,
    pub ns: Str,
}

The socket.io packet type. Each packet has a type and a namespace

Fields

inner: PacketData

The packet data

ns: Str

The namespace the packet belongs to

Implementations

impl Packet

pub fn connect(ns: impl Into<Str>, value: Option<Value>) -> Self

Send a connect packet with a default payload for v5 and no payload for v4

pub fn disconnect(ns: impl Into<Str>) -> Self

Create a disconnect packet for the given namespace

impl Packet

pub fn connect_error(ns: impl Into<Str>, message: impl Into<String>) -> Self

Create a connect error packet for the given namespace with a message

pub fn event(ns: impl Into<Str>, data: Value) -> Self

Create an event packet for the given namespace. If the there is adjacent binary data, it will be a binary packet.

pub fn ack(ns: impl Into<Str>, data: Value, ack: i64) -> Self

Create an ack packet for the given namespace. If the there is adjacent binary data, it will be a binary packet.

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

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl PartialEq for Packet

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

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Packet