Skip to main content

WsOutboundEvent

ferrischat_common::ws

Enum WsOutboundEvent

pub enum WsOutboundEvent {
Show 24 variants    IdentifyAccepted {
        user: User,
    },
    Ping,
    Pong,
    MessageCreate {
        message: Message,
    },
    MessageUpdate {
        old: Message,
        new: Message,
    },
    MessageDelete {
        message: Message,
    },
    ChannelCreate {
        channel: Channel,
    },
    ChannelUpdate {
        old: Channel,
        new: Channel,
    },
    ChannelDelete {
        channel: Channel,
    },
    GuildCreate {
        guild: Guild,
    },
    GuildUpdate {
        old: Guild,
        new: Guild,
    },
    GuildDelete {
        guild: Guild,
    },
    MemberCreate {
        member: Member,
    },
    MemberUpdate {
        old: Member,
        new: Member,
    },
    MemberDelete {
        member: Member,
    },
    InviteCreate {
        invite: Invite,
    },
    InviteDelete {
        invite: Invite,
    },
    RoleCreate {
        role: Role,
    },
    RoleUpdate {
        old: Role,
        new: Role,
    },
    RoleDelete {
        role: Role,
    },
    TypingStart {
        channel: Channel,
        user: User,
    },
    TypingEnd {
        channel: Channel,
        user: User,
    },
    MemberRoleAdd {
        member: Member,
        role: Role,
    },
    MemberRoleDelete {
        member: Member,
        role: Role,
    },
}

Expand description

Server -> client WebSocket events.

Variants§

IdentifyAccepted

Fired when an Identify is accepted as valid.

user is the now-authorized user.

Fields

§user: User

Ping

Pong

MessageCreate

Fired when a new message is created.

message is the message that was created.

Fields

§message: Message

MessageUpdate

Fired when a message is updated.

old is the message before the edit. new is the message after the edit.

Fields

§old: Message

§new: Message

MessageDelete

Fired when a message is deleted.

message is the message that was deleted.

Fields

§message: Message

ChannelCreate

Fields

§channel: Channel

ChannelUpdate

Fields

§old: Channel

§new: Channel

ChannelDelete

Fields

§channel: Channel

GuildCreate

Fields

§guild: Guild

GuildUpdate

Fields

§old: Guild

§new: Guild

GuildDelete

Fields

§guild: Guild

MemberCreate

Fields

§member: Member

MemberUpdate

Fields

§old: Member

§new: Member

MemberDelete

Fields

§member: Member

InviteCreate

Fields

§invite: Invite

InviteDelete

Fields

§invite: Invite

RoleCreate

Fields

§role: Role

RoleUpdate

Fields

§old: Role

§new: Role

RoleDelete

Fields

§role: Role

TypingStart

Fields

§channel: Channel

§user: User

TypingEnd

Fields

§channel: Channel

§user: User

MemberRoleAdd

Fields

§member: Member

§role: Role

MemberRoleDelete

Fields

§member: Member

§role: Role

Trait Implementations§

impl<'de> Deserialize<'de> for WsOutboundEvent

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 WsOutboundEvent

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 Freeze for WsOutboundEvent

impl RefUnwindSafe for WsOutboundEvent

impl Send for WsOutboundEvent

impl Sync for WsOutboundEvent

impl Unpin for WsOutboundEvent

impl UnsafeUnpin for WsOutboundEvent

impl UnwindSafe for WsOutboundEvent

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,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

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, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

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.

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

Performs the conversion.