Struct ttv_chat::messages::ClearChat

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

When a user's message(s) have been purged.

Typically after a user is banned from chat or timed out

Implementations

impl<'a> ClearChat<'a>

pub fn raw(&self) -> &str

Get the raw message

pub fn tags(&self) -> Tags<'_>

Get a view of parsable tags

pub fn channel(&self) -> &str

The channel this event happened on

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

The user, if any, that was being purged

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

(Optional) Duration of the timeout, in seconds. If omitted, the ban is permanent.

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

The room id this event happened on

Trait Implementations

impl<'a> Clone for ClearChat<'a>

fn clone(&self) -> ClearChat<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ClearChat<'a>

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

Formats the value using the given formatter.

impl<'a> From<ClearChat<'a>> for Commands<'a>

fn from(msg: ClearChat<'a>) -> Commands<'a>

Performs the conversion.

impl<'a> FromIrcMessage<'a> for ClearChat<'a>

type Error = MessageError

An error returned if this message could not be parsed.

fn from_irc(
    msg: IrcMessage<'a>
) -> Result<ClearChat<'a>, <ClearChat<'a> as FromIrcMessage<'a>>::Error>

This method consumes an IrcMessage and tries to produce an instance of Self

fn into_inner(self) -> MaybeOwned<'a>

Consumes the message, returning the raw MaybeOwned<'_>

impl<'a> IntoOwned<'a> for ClearChat<'a>

type Output = ClearChat<'static>

The output type

fn into_owned(self) -> <ClearChat<'a> as IntoOwned<'a>>::Output

Consumes self, returning an owned version

impl<'a> PartialEq<ClearChat<'a>> for ClearChat<'a>

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

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

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

This method tests for !=.

impl<'a> StructuralPartialEq for ClearChat<'a>