Struct twitchchat::Writer

pub struct Writer<W>(pub Arc<Mutex<W>>);

A thread-safe, clonable writer for the Twitch client

Methods

impl<W: Write> Writer<W>

pub fn host(&self, channel: &str) -> Result<(), Error>

pub fn unhost(&self) -> Result<(), Error>

pub fn marker(&self, comment: Option<&str>) -> Result<(), Error>

pub fn raid(&self, channel: &str) -> Result<(), Error>

pub fn unraid(&self) -> Result<(), Error>

pub fn color<C: Into<TwitchColor>>(&self, color: C) -> Result<(), Error>

pub fn disconnect(&self) -> Result<(), Error>

pub fn help(&self) -> Result<(), Error>

pub fn mods(&self) -> Result<(), Error>

pub fn vips(&self) -> Result<(), Error>

pub fn commercial(&self, length: Option<usize>) -> Result<(), Error>

pub fn ban(&self, username: &str, reason: Option<&str>) -> Result<(), Error>

pub fn unban(&self, username: &str) -> Result<(), Error>

pub fn clear(&self) -> Result<(), Error>

pub fn emoteonly(&self) -> Result<(), Error>

pub fn emoteonlyoff(&self) -> Result<(), Error>

pub fn followers(&self, duration: &str) -> Result<(), Error>

pub fn followersoff(&self) -> Result<(), Error>

pub fn op(&self, username: &str) -> Result<(), Error>

pub fn unmod(&self, username: &str) -> Result<(), Error>

pub fn r9kbeta(&self) -> Result<(), Error>

pub fn r9kbetaoff(&self) -> Result<(), Error>

pub fn slow(&self, duration: Option<usize>) -> Result<(), Error>

pub fn slowoff(&self) -> Result<(), Error>

pub fn subscribers(&self) -> Result<(), Error>

pub fn subscribersoff(&self) -> Result<(), Error>

pub fn timeout(
    &self,
    username: &str,
    duration: Option<&str>,
    reason: Option<&str>
) -> Result<(), Error>

pub fn untimeout(&self, username: &str) -> Result<(), Error>

pub fn vip(&self, username: &str) -> Result<(), Error>

pub fn unvip(&self, username: &str) -> Result<(), Error>

pub fn whisper(&self, username: &str, message: &str) -> Result<(), Error>

pub fn join<C: Into<Channel>>(&self, channel: C) -> Result<(), Error>

Joins a channel

This ensures the channel name is lowercased and begins with a '#'.

The following are equivilant

let w = client.writer();
w.join("museun").unwrap();
w.join("#museun").unwrap();
w.join("Museun").unwrap();
w.join("#MUSEUN").unwrap();

pub fn part<C: Into<Channel>>(&self, channel: C) -> Result<(), Error>

Parts a channel

This ensures the channel name is lowercased and begins with a '#'.

The following are equivilant

let w = client.writer();
w.part("museun").unwrap();
w.part("#museun").unwrap();
w.part("Museun").unwrap();
w.part("#MUSEUN").unwrap();

pub fn me<C, S>(&self, channel: C, message: S) -> Result<(), Error> where
    C: Into<Channel>,
    S: AsRef<str>, 

Sends an "emote" message in the third person to the channel

This ensures the channel name is lowercased and begins with a '#'.

pub fn privmsg<C, S>(&self, channel: C, message: S) -> Result<(), Error> where
    C: Into<Channel>,
    S: AsRef<str>, 

Sends the message to the channel

This ensures the channel name is lowercased and begins with a '#'.

Same as send

pub fn send<C, S>(&self, channel: C, message: S) -> Result<(), Error> where
    C: Into<Channel>,
    S: AsRef<str>, 

Sends the message to the channel

This ensures the channel name is lowercased and begins with a '#'.

Same as privmsg

pub fn command<S>(&self, data: S) -> Result<(), Error> where
    S: AsRef<str>, 

Sends the command: data (e.g. /color #FFFFFF)

pub fn raw<S>(&self, data: S) -> Result<(), Error> where
    S: AsRef<str>, 

Sends a raw line (appends the required \r\n)

Trait Implementations

impl<W: Write> WriterExt for Writer<W>

fn join_many_limited<'a, I, S>(
    &self,
    channels: I,
    rate: Option<RateLimit>
) -> Result<(), Error> where
    I: IntoIterator<Item = S> + 'a,
    S: AsRef<str> + 'a, 

Join a (huge) list of channels but using a RateLimit

fn join_many<'a, I, S>(&self, channels: I) -> Result<(), Error> where
    I: IntoIterator<Item = S> + 'a,
    S: AsRef<str> + 'a, 

Join a (huge) list of channels

impl<W: Write> Clone for Writer<W>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.