Skip to main content

Event

Enum Event 

Source
pub enum Event {
Show 21 variants Chat(ChatLine), Backfill(Vec<ChatLine>), Delete { line: Option<ChatLine>, del: Delete, }, Special(SpecialLine), FeedHeat { id: String, heat: f64, }, FeedHidden { id: String, }, Batch(Vec<Event>), Auth(bool), SendResult { ok: bool, error: Option<String>, }, FollowLive(Vec<(Platform, String)>), FollowHistory(Vec<(ChatLine, u64)>), FollowColors(Vec<(String, String)>), Pin(Platform, String, Option<Pin>), Room(String, RoomState), Pong, Color { id: Option<String>, names: Vec<String>, color: String, }, Cosmetic(Vec<String>), FeedEdit { id: String, text: String, emotes: Vec<Emote>, }, Account, Follows, Ignore,
}
Expand description

what an inbound frame turned into.

Variants§

§

Chat(ChatLine)

§

Backfill(Vec<ChatLine>)

§

Delete

lines removed by a mod, plus the mod-log note to show (clearchat has one; a single deleted message doesn’t).

Fields

§

Special(SpecialLine)

a mention-rule hit, whisper, DM or feed row for a virtual tab.

§

FeedHeat

a feed row’s heat moved (heat:updated).

Fields

§heat: f64
§

FeedHidden

a feed row was hidden by moderation (message:hidden).

Fields

§

Batch(Vec<Event>)

several events from one frame, in order.

§

Auth(bool)

authentication outcome (true = ok).

§

SendResult

result of an outbound send: ok, or an error reason.

Fields

§ok: bool
§

FollowLive(Vec<(Platform, String)>)

followed channels already live at connect (follow:live:snapshot) — catch-up, never lines.

§

FollowHistory(Vec<(ChatLine, u64)>)

the user’s last day of follow events (follow:history), oldest first: each a follow stream line plus its unix-ms time.

§

FollowColors(Vec<(String, String)>)

follow:colors: channel login (lowercase) → #rrggbb.

§

Pin(Platform, String, Option<Pin>)

a channel pin was set (Some) or cleared (None).

§

Room(String, RoomState)

a twitch ROOMSTATE: the channel’s current chat modes.

§

Pong

§

Color

profile:color: a user’s picked name color, by paint-space id.

Fields

§id: Option<String>

paint-space id, when the push named one.

§names: Vec<String>

the user’s linked usernames, lowercased (platform not stated).

§color: String
§

Cosmetic(Vec<String>)

cosmetic:changed: paints changed for these paint-space ids.

§

FeedEdit

message-edited / message-updated: a feed row’s text (and the emote refs it now renders with) changed.

Fields

§text: String
§emotes: Vec<Emote>
§

Account

account:changed: linked platforms or scopes moved — re-ask who I am.

§

Follows

follows:changed: the follow list moved — refetch it.

§

Ignore

Trait Implementations§

Source§

impl Clone for Event

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Event

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Event

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Event

Auto Trait Implementations§

§

impl Forget for Event

§

impl Freeze for Event

§

impl Move for Event

§

impl RefUnwindSafe for Event

§

impl Send for Event

§

impl Sync for Event

§

impl Unpin for Event

§

impl UnsafeUnpin for Event

§

impl UnwindSafe for Event

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.