Enum trovo::chat::ChatSocketMessage

source · [−]

pub enum ChatSocketMessage {
    Auth {
        nonce: String,
        data: ChatToken,
    },
    Response {
        nonce: String,
    },
    Ping {
        nonce: String,
    },
    Pong {
        nonce: String,
        data: PongMessageData,
    },
    Chat {
        channel_info: Option<ChannelInfo>,
        data: ChatMessageData,
    },
}

Expand description

Messages that can be sent over the socket to interact with the Trovo chat api

Variants

`Auth`

Fields

nonce: String

Sent back in responses, used to map a request to a reply

data: ChatToken

Object containing the chat token to authenticate with

Authenticate the chat session

`Response`

Fields

nonce: String

Sent back in responses, used to map a request to a reply

Sent by Trovo to acknowledge the auth message

`Ping`

Fields

nonce: String

Sent back in responses, used to map a request to a reply

A simple ping message to keep the chat socket alive

`Pong`

Fields

nonce: String

Sent back in responses, used to map a request to a reply

data: PongMessageData

Ping response data

Response to sending a ping message.

`Chat`

Fields

channel_info: Option<ChannelInfo>

Contains information about which channel the messages were sent in.

Seemingly not present on historic chat messages.

data: ChatMessageData

Chat message data

Sent by trovo when a chat message is sent in chat. May contain mulptiple chat messages at a time.

This is also sent on connection to a channel if there were recent chat messages.

Trait Implementations

impl Debug for ChatSocketMessage

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for ChatSocketMessage

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

Deserialize this value from the given Serde deserializer. Read more

impl Serialize for ChatSocketMessage

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

impl RefUnwindSafe for ChatSocketMessage

impl Send for ChatSocketMessage

impl Sync for ChatSocketMessage

impl Unpin for ChatSocketMessage

impl UnwindSafe for ChatSocketMessage

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

const: unstable · 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.

impl<T> Same<T> for T

type Output = T

Should always be Self

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,