Struct CommonParser

pub struct CommonParser;

Parse and serialize from and into the socket.io common packet format. See details in the socket.io protocol doc.

Trait Implementations

impl Clone for CommonParser

fn clone(&self) -> CommonParser

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommonParser

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

Formats the value using the given formatter.

impl Default for CommonParser

fn default() -> CommonParser

Returns the “default value” for a type.

impl Parse for CommonParser

fn encode(self, packet: Packet) -> Value

Convert a packet into multiple payloads to be sent.

fn decode_str( self, state: &ParserState, value: Str, ) -> Result<Packet, ParseError>

Parse a given input string. If the payload needs more adjacent binary packet, the partial packet will be kept and a ParseError::NeedsMoreBinaryData will be returned.

fn decode_bin( self, state: &ParserState, data: Bytes, ) -> Result<Packet, ParseError>

Parse a given input binary. If the payload needs more adjacent binary packet, the partial packet is still kept and a ParseError::NeedsMoreBinaryData will be returned.

fn encode_value<T: ?Sized + Serialize>( self, data: &T, event: Option<&str>, ) -> Result<Value, ParserError>

Convert any serializable data to a generic Value to be later included as a payload in the packet.

fn decode_value<'de, T: Deserialize<'de>>( self, value: &'de mut Value, with_event: bool, ) -> Result<T, ParserError>

Convert any generic Value to a deserializable type. It should always be an array (according to the serde model).

fn decode_default<'de, T: Deserialize<'de>>( self, value: Option<&'de Value>, ) -> Result<T, ParserError>

Convert any generic Value to a type with the default serde impl without binary + event tricks. This is mainly used for connect payloads.

fn encode_default<T: ?Sized + Serialize>( self, data: &T, ) -> Result<Value, ParserError>

Convert any type to a generic Value with the default serde impl without binary + event tricks. This is mainly used for connect payloads.

fn read_event(self, value: &Value) -> Result<&str, ParserError>

Try to read the event name from the given payload data. The event name should be the first element of the provided array according to the serde model.

impl Copy for CommonParser