Struct twilight_model::gateway::event::gateway::GatewayEventDeserializer

pub struct GatewayEventDeserializer<'a> { /* private fields */ }

Deserialize into a GatewayEvent by knowing its dispatch event type and opcode.

Implementations

impl<'a> GatewayEventDeserializer<'a>

pub fn new(op: u8, event_type: Option<&'a str>) -> Self

Create a new gateway event deserializer when you already know the opcode and dispatch event type.

pub fn from_json(input: &'a str) -> Option<Self>

Create a gateway event deserializer by scanning the JSON payload for its opcode and dispatch event type.

pub fn into_owned(self) -> GatewayEventDeserializer<'static>

Create a deserializer with an owned event type.

This is necessary when using a mutable deserialization library such as simd-json.

pub fn into_parts(self) -> (u8, Option<u64>, Option<Cow<'a, str>>)

Consume the deserializer, returning its components.

pub fn event_type(&self) -> Option<&str>

Dispatch event type of the payload.

pub const fn op(&self) -> u8

Opcode of the payload.

pub const fn sequence(&self) -> Option<u64>

Sequence of the payload.

May only be available if the deserializer was created via from_json

Trait Implementations

impl<'a> Debug for GatewayEventDeserializer<'a>

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

Formats the value using the given formatter.

impl<'de> DeserializeSeed<'de> for GatewayEventDeserializer<'_>

type Value = GatewayEvent

The type produced by using this seed.

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

Equivalent to the more common Deserialize::deserialize method, except with some initial piece of data (the seed) passed in.