Struct twitchchat::Encoder

pub struct Encoder<W> { /* fields omitted */ }

An encoder for messages

Implementations

impl<W: Write> Encoder<W>

pub fn into_inner(self) -> W

Gets the inner writer out

pub fn inner_mut(&mut self) -> &mut W

Get a mutable borrow of the inner writer

pub fn inner(&self) -> &W

Get a borrow of the inner writer

pub fn new(writer: W) -> Self

Make a new encoder from this writer

impl<W: Write> Encoder<W>

pub fn ban<'a>(
    &mut self,
    channel: impl IntoChannel,
    username: &str,
    reason: impl Into<Option<&'a str>>
) -> Result<(), Error>

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

Use unban to remove a ban.

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

Clear chat history for all users in this room.

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

Change your username color.

pub fn command(
    &mut self,
    channel: impl IntoChannel,
    data: &str
) -> Result<(), Error>

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

pub fn jtv_command(&mut self, data: &str) -> Result<(), Error>

Sends the command: data to the 'jtv' channel (e.g. /color #FFFFFF)

pub fn commercial(
    &mut self,
    channel: impl IntoChannel,
    length: impl Into<Option<usize>>
) -> Result<(), Error>

Triggers a commercial.

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

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

Reconnects to chat.

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

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

Use emote_only_off to disable.

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

Disables emote-only mode.

pub fn followers(
    &mut self,
    channel: impl IntoChannel,
    duration: &str
) -> 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 followers_off(&mut self, channel: impl IntoChannel) -> Result<(), Error>

Disables followers-only mode.

pub fn give_mod(
    &mut self,
    channel: impl IntoChannel,
    username: &str
) -> Result<(), Error>

Grant moderator status to a user.

Use mods to list the moderators of this channel.

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

Lists the commands available to you in this room.

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

Host another channel.

Use unhost to unset host mode.

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

Join a channel

pub fn marker<'a>(
    &mut self,
    channel: impl IntoChannel,
    comment: impl Into<Option<&'a 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.

If the string exceeds 140 characters then it will be truncated

pub fn me(
    &mut self,
    channel: impl IntoChannel,
    message: impl AsRef<str>
) -> Result<(), Error>

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

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

Lists the moderators of this channel.

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

Leave a channel

pub fn ping(&mut self, token: impl AsRef<str>) -> Result<(), Error>

Request a heartbeat with the provided token

pub fn pong(&mut self, token: impl AsRef<str>) -> Result<(), Error>

Response to a heartbeat with the provided token

pub fn privmsg(
    &mut self,
    channel: impl IntoChannel,
    data: impl AsRef<str>
) -> Result<(), Error>

Send data to a channel

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

Enables r9k mode.

Use r9k_beta_off to disable.

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

Disables r9k mode.

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

Raid another channel.

Use unraid to cancel the Raid.

pub fn raw(&mut self, raw: impl AsRef<[u8]>) -> Result<(), Error>

Send a raw IRC-style message

pub fn slow(
    &mut self,
    channel: impl IntoChannel,
    duration: impl Into<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 slow_off to disable.

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

Disables slow mode.

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

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

Use subscribers_off to disable.

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

Disables subscribers-only mode.

pub fn timeout<'a, 'b>(
    &mut self,
    channel: impl IntoChannel,
    username: &str,
    duration: impl Into<Option<&'a str>>,
    message: impl Into<Option<&'b 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 untimeout to remove a timeout.

pub fn unban(
    &mut self,
    channel: impl IntoChannel,
    username: impl AsRef<str>
) -> Result<(), Error>

Removes a ban on a user.

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

Stop hosting another channel.

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

Revoke moderator status from a user.

Use mods to list the moderators of this channel.

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

Cancel the Raid.

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

Removes a timeout on a user.

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

Revoke VIP status from a user.

Use vips to list the VIPs of this channel.

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

Grant VIP status to a user.

Use vips to list the VIPs of this channel.

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

Lists the VIPs of this channel.

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

Whispers the message to the username.

Trait Implementations

impl<W: Write + Clone> Clone for Encoder<W>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<W> Debug for Encoder<W>

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

Formats the value using the given formatter.

impl<W: Write + Default> Default for Encoder<W>

fn default() -> Self

Returns the "default value" for a type.