Skip to main content

Packet

Struct Packet 

Source
pub struct Packet {
    pub packet_type: PacketId,
    pub nsp: String,
    pub data: Option<String>,
    pub id: Option<u64>,
    pub attachment_count: u8,
    pub attachments: Option<Vec<Bytes>>,
}
Expand description

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

Fields§

§packet_type: PacketId§nsp: String§data: Option<String>

The JSON payload as text, placeholders included.

§id: Option<u64>§attachment_count: u8§attachments: Option<Vec<Bytes>>

Implementations§

Source§

impl Packet

Source

pub fn new_event( payload: Payload, event: &str, nsp: &str, id: Option<u64>, ) -> Result<Packet>

An EVENT (or BINARY_EVENT when the payload carries buffers) for event.

Source

pub fn new_ack(payload: Payload, nsp: &str, id: u64) -> Result<Packet>

The ACK (or BINARY_ACK) that answers the server’s event id.

Source

pub fn event_payload(&self) -> Result<(String, Payload)>

Event name and arguments of an EVENT / BINARY_EVENT.

The first argument is the name when it is a string (or a number, which socket.io-parser also accepts). Deliberate difference from socket.io-client, kept from rust_socketio: a binary event without a name (emit(buffer) on the server) is named "message".

Source

pub fn ack_payload(&self) -> Result<Payload>

The arguments of an ACK / BINARY_ACK.

Source§

impl Packet

Source

pub const fn new( packet_type: PacketId, nsp: String, data: Option<String>, id: Option<u64>, attachment_count: u8, attachments: Option<Vec<Bytes>>, ) -> Self

Creates an instance.

Trait Implementations§

Source§

impl Clone for Packet

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Packet

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Packet

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for Packet

Source§

impl From<&Packet> for Bytes

Source§

fn from(packet: &Packet) -> Bytes

socket.io-parser encodeAsString: type, <attachments>-, <nsp>, (unless /), id, JSON. The attachments themselves are sent by the socket as separate binary messages.

Source§

impl From<Packet> for Bytes

Source§

fn from(packet: Packet) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Packet

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Packet

Source§

impl TryFrom<&Bytes> for Packet

Source§

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

socket.io-parser decodeString. The attachments of a binary packet arrive as separate engine.io messages; the socket fills attachments in.

Source§

type Error = Error

The type returned in the event of a conversion error.
Source§

impl TryFrom<Bytes> for Packet

Source§

type Error = Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more