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

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

A deserializer that deserializes into a GatewayEvent by borrowing some bits of scanned information before the actual deserialisation.

This is the borrowed version of GatewayEventDeserializerOwned.

You should use this if you're using an immutable deserialization library like serde_json.

Implementations

impl<'a> GatewayEventDeserializer<'a>

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

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

This might be useful if you scan the payload for this information and do some work with the event type prior to deserializing the payload.

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

Create a gateway event deserializer with some information found by scanning the JSON payload to deserialise.

This will scan the payload for the opcode and, optionally, event type if provided. The opcode key ("op"), must be in the payload while the event type key ("t") is optional and only required for event ops.

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

Return an immutable reference to the event type of the payload.

pub fn op(&self) -> u8

Return the opcode of the payload.

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

Return the sequence of the payload.

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

Consume the deserializer, returning its opcode and event type components.

Trait Implementations

impl<'a> Clone for GatewayEventDeserializer<'a>

pub fn clone(&self) -> GatewayEventDeserializer<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

pub 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.

pub 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.

impl<'a> Eq for GatewayEventDeserializer<'a>

impl<'a> PartialEq<GatewayEventDeserializer<'a>> for GatewayEventDeserializer<'a>

pub fn eq(&self, other: &GatewayEventDeserializer<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &GatewayEventDeserializer<'a>) -> bool

This method tests for !=.

impl<'a> StructuralEq for GatewayEventDeserializer<'a>

impl<'a> StructuralPartialEq for GatewayEventDeserializer<'a>