Enum serenity_voice_model::Event

#[non_exhaustive]pub enum Event {
    Identify(Identify),
    SelectProtocol(SelectProtocol),
    Ready(Ready),
    Heartbeat(Heartbeat),
    SessionDescription(SessionDescription),
    Speaking(Speaking),
    HeartbeatAck(HeartbeatAck),
    Resume(Resume),
    Hello(Hello),
    Resumed,
    ClientConnect(ClientConnect),
    ClientDisconnect(ClientDisconnect),
}

A representation of data received for voice gateway events.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Identify(Identify)

Used to begin a voice websocket connection.

SelectProtocol(SelectProtocol)

Used to select the voice protocol and encryption mechanism.

Ready(Ready)

Server's response to the client's Identify operation. Contains session-specific information, e.g. SSRC, and supported encryption modes.

Heartbeat(Heartbeat)

Periodic messages used to keep the websocket connection alive.

SessionDescription(SessionDescription)

Server's confirmation of a negotiated encryption scheme.

Speaking(Speaking)

A voice event denoting that someone is speaking.

HeartbeatAck(HeartbeatAck)

Acknowledgement from the server for a prior voice heartbeat.

Resume(Resume)

Sent by the client after a disconnect to attempt to resume a session.

Hello(Hello)

Used to determine how often the client must send a heartbeat.

Resumed

Message received if a Resume request was successful.

ClientConnect(ClientConnect)

Status update in the current channel, indicating that a user has connected.

ClientDisconnect(ClientDisconnect)

Status update in the current channel, indicating that a user has disconnected.

Implementations

impl Event

pub fn kind(&self) -> OpCode

Trait Implementations

impl Clone for Event

pub fn clone(&self) -> Event

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Event

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

Deserialize this value from the given Serde deserializer.

impl From<ClientConnect> for Event

pub fn from(i: ClientConnect) -> Self

Performs the conversion.

impl From<ClientDisconnect> for Event

pub fn from(i: ClientDisconnect) -> Self

Performs the conversion.

impl From<Heartbeat> for Event

pub fn from(i: Heartbeat) -> Self

Performs the conversion.

impl From<HeartbeatAck> for Event

pub fn from(i: HeartbeatAck) -> Self

Performs the conversion.

impl From<Hello> for Event

pub fn from(i: Hello) -> Self

Performs the conversion.

impl From<Identify> for Event

pub fn from(i: Identify) -> Self

Performs the conversion.

impl From<Ready> for Event

pub fn from(i: Ready) -> Self

Performs the conversion.

impl From<Resume> for Event

pub fn from(i: Resume) -> Self

Performs the conversion.

impl From<SelectProtocol> for Event

pub fn from(i: SelectProtocol) -> Self

Performs the conversion.

impl From<SessionDescription> for Event

pub fn from(i: SessionDescription) -> Self

Performs the conversion.

impl From<Speaking> for Event

pub fn from(i: Speaking) -> Self

Performs the conversion.

impl Serialize for Event

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

Serialize this value into the given Serde serializer.