Enum Packet 

pub enum Packet {
    Open(OpenPacket),
    Close,
    Ping,
    Pong,
    PingUpgrade,
    PongUpgrade,
    Message(Str),
    Upgrade,
    Noop,
    Binary(Bytes),
    BinaryV3(Bytes),
}

A Packet type to use when receiving and sending data from the client

Variants

Open(OpenPacket)

Open packet used to initiate a connection

Close

Close packet used to close a connection

Ping

Ping packet used to check if the connection is still alive The client never sends this packet, it is only used by the server

Pong

Pong packet used to respond to a Ping packet The server never sends this packet, it is only used by the client

PingUpgrade

Special Ping packet used to initiate a connection

PongUpgrade

Special Pong packet used to respond to a PingUpgrade packet and upgrade the connection

Message(Str)

Message packet used to send a message to the client

Upgrade

Upgrade packet to upgrade the connection from polling to websocket

Noop

Noop packet used to send something to a opened polling connection so it gracefully closes to allow the client to upgrade to websocket

Binary(Bytes)

Binary packet used to send binary data to the client Converts to a String using base64 encoding when using polling connection Or to a websocket binary frame when using websocket connection

When receiving, it is only used with polling connection, websocket use binary frame

BinaryV3(Bytes)

Binary packet used to send binary data to the client Converts to a String using base64 encoding when using polling connection Or to a websocket binary frame when using websocket connection

When receiving, it is only used with polling connection, websocket use binary frame

This is a special packet, excepionally specific to the V3 protocol.

Implementations

impl Packet

pub fn is_binary(&self) -> bool

Check if the packet is a binary packet

pub fn into_message(self) -> Str

If the packet is a message packet (text), it returns the message

pub fn into_binary(self) -> Bytes

If the packet is a binary packet, it returns the binary data

pub fn get_size_hint(&self, b64: bool) -> usize

Get the max size the packet could have when serialized

If b64 is true, it returns the max size when serialized to base64

The base64 max size factor is ceil(n / 3) * 4

impl Packet

Deserialize a Packet from a String according to the Engine.IO protocol

pub fn parse( protocol: ProtocolVersion, value: impl Into<Str>, ) -> Result<Self, PacketParseError>

Parses a packet from a string value using the specified protocol version.

Trait Implementations

impl Clone for Packet

fn clone(&self) -> Packet

Returns a duplicate 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 From<Packet> for Bytes

fn from(value: Packet) -> Self

Converts to this type from the input type.

impl From<Packet> for String

Serialize a Packet to a String according to the Engine.IO protocol

fn from(packet: Packet) -> String

Converts to this type from the input type.

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 StructuralPartialEq for Packet