Skip to main content

Payload

Enum Payload 

Source
pub enum Payload {
    Binary(Bytes, Option<i32>),
    Text(Vec<Value>, Option<i32>),
    String(String, Option<i32>),
}
Expand description

A type which represents a payload in the socket.io context. A payload could either be of the type Payload::Binary, which holds data in the Bytes type that represents the payload or of the type Payload::String which holds a std::string::String. The enum is used for both representing data that’s send and data that’s received. The optional i32 field represents the ack ID if this payload requires acknowledgment from the server.

Variants§

§

Binary(Bytes, Option<i32>)

§

Text(Vec<Value>, Option<i32>)

§

String(String, Option<i32>)

👎Deprecated:

Use Payload::Text instead. Continue existing behavior with: Payload::from(String)

String that is sent as JSON if this is a JSON string, or as a raw string if it isn’t

Implementations§

Source§

impl Payload

Source

pub fn with_ack_id<T: Into<Self>>(payload: T, ack_id: i32) -> Self

创建一个带ack_id的payload

Source

pub fn ack_id(&self) -> Option<i32>

获取payload的ack_id

Source

pub fn set_ack_id(&mut self, ack_id: Option<i32>)

设置payload的ack_id

Source

pub fn data(&self) -> PayloadData<'_>

获取payload的数据部分(不包含ack_id)

Trait Implementations§

Source§

impl Clone for Payload

Source§

fn clone(&self) -> Payload

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Payload

Source§

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

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

impl From<&'static [u8]> for Payload

Source§

fn from(val: &'static [u8]) -> Self

Converts to this type from the input type.
Source§

impl From<&str> for Payload

Source§

fn from(string: &str) -> Self

Converts to this type from the input type.
Source§

impl From<Bytes> for Payload

Source§

fn from(bytes: Bytes) -> Self

Converts to this type from the input type.
Source§

impl From<String> for Payload

Source§

fn from(string: String) -> Self

Converts to this type from the input type.
Source§

impl From<Value> for Payload

Source§

fn from(value: Value) -> Self

Converts to this type from the input type.
Source§

impl From<Vec<String>> for Payload

Source§

fn from(arr: Vec<String>) -> Self

Converts to this type from the input type.
Source§

impl From<Vec<Value>> for Payload

Source§

fn from(values: Vec<Value>) -> Self

Converts to this type from the input type.
Source§

impl From<Vec<u8>> for Payload

Source§

fn from(val: Vec<u8>) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Payload

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Payload

Source§

impl StructuralPartialEq for Payload

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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: 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: 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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