Struct twitchchat::Writer

pub struct Writer { /* fields omitted */ }

A thread-safe, clonable writer for the Twitch client

Methods

impl Writer

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

Host another channel.

Use Writer::unhost to unset host mode.

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

Stop hosting another channel.

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

Adds a stream marker (with an optional comment, max 140 characters) at the current timestamp.

You can use markers in the Highlighter for easier editing.

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

Raid another channel.

Use Writer::unraid to cancel the Raid.

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

Cancel the Raid.

pub fn color(&self, color: Color) -> Result<(), Error>

Change your username color.

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

Reconnects to chat.

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

Lists the commands available to you in this room.

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

Lists the moderators of this channel.

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

Lists the VIPs of this channel.

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

Triggers a commercial.

Length (optional) must be a positive number of seconds.

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

Permanently prevent a user from chatting. Reason is optional and will be shown to the target user and other moderators.

Use Writer::unban to remove a ban.

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

Removes a ban on a user.

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

Clear chat history for all users in this room.

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

Enables emote-only mode (only emoticons may be used in chat).

Use Writer::emoteonlyoff to disable.

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

Disables emote-only mode.

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

Enables followers-only mode (only users who have followed for 'duration' may chat).

Examples: "30m", "1 week", "5 days 12 hours".

Must be less than 3 months.

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

Disables followers-only mode.

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

Grant moderator status to a user.

Use Writer::mods to list the moderators of this channel.

(NOTE: renamed to op because r#mod is annoying to type)

pub fn mod(&self, username: impl Display) -> Result<(), Error>

Grant moderator status to a user. (See Writer::op for an alternative name)

Use Writer::mods to list the moderators of this channel.

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

Revoke moderator status from a user.

Use Writer::mods to list the moderators of this channel.

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

Enables r9k mode.

Use Writer::r9kbetaoff to disable.

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

Disables r9k mode.

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

Enables slow mode (limit how often users may send messages).

Duration (optional, default=120) must be a positive number of seconds.

Use Writer::slowoff to disable.

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

Disables slow mode.

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

Enables subscribers-only mode (only subscribers may chat in this channel).

Use Writer::subscribersoff to disable.

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

Disables subscribers-only mode.

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

Temporarily prevent a user from chatting.

• duration (optional, default=10 minutes) must be a positive integer.
• time unit (optional, default=s) must be one of
  • s
  • m
  • h
  • d
  • w
• maximum duration is 2 weeks.

Combinations like 1d2h are also allowed.

Reason is optional and will be shown to the target user and other moderators.

Use Writer::untimeout to remove a timeout.

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

Removes a timeout on a user.

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

Grant VIP status to a user.

Use Writer::vips to list the VIPs of this channel.

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

Revoke VIP status from a user.

Use Writer::vips to list the VIPs of this channel.

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

Whispers the message to the username.

pub fn join(&self, channel: impl IntoChannel) -> 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 shutdown_client(&self)

This is used to signal to the Client to shutdown

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

Join many channels (from an iterator)

pub fn part(&self, channel: impl IntoChannel) -> 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(
    &self,
    channel: impl IntoChannel,
    message: impl Display
) -> Result<(), Error>

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(
    &self,
    channel: impl IntoChannel,
    message: impl Display
) -> Result<(), Error>

Sends the message to the channel

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

Same as send

pub fn send(
    &self,
    channel: impl IntoChannel,
    message: impl Display
) -> Result<(), Error>

Sends the message to the channel

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

Same as privmsg

pub fn command(&self, data: impl Display) -> Result<(), Error>

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

pub fn raw(&self, data: impl Display) -> Result<(), Error>

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

Trait Implementations

impl Clone for Writer

fn clone(&self) -> Writer

Returns a copy of the value.

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

Performs copy-assignment from source.