Enum async_circe::commands::Command

pub enum Command {
    ADMIN(String),
    AWAY(String),
    INVITE(String, String),
    JOIN(String),
    LIST(Option<String>, Option<String>),
    MODE(String, Option<String>),
    NAMES(String, Option<String>),
    OPER(String, String),
    OTHER(String),
    PART(String),
    PRIVMSG(String, String, String),
    QUIT(String),
    TOPIC(String, Option<String>),
    // some variants omitted
}

IRC commands

Variants

ADMIN(String)

Tuple Fields

0: String

Target

Gets information about the admin of the IRC server.

client.admin("192.168.178.100").await?;

AWAY(String)

Tuple Fields

0: String

Message

Sets the user status to AWAY

client.away("AFK").await?;

INVITE(String, String)

Tuple Fields

0: String

User

1: String

Channel

Invite user to channel

client.invite("liblirc", "#circe").await?;

JOIN(String)

Tuple Fields

0: String

Channel

Joins a channel

client.join("#main").await?;

LIST(Option<String>, Option<String>)

Tuple Fields

0: Option<String>

Channel

1: Option<String>

Server to foreward request to

Lists all channels and their topics

client.list(None, None).await?;

MODE(String, Option<String>)

Tuple Fields

0: String

Channel

1: Option<String>

Mode

Sets the mode of the user

client.mode("test", Some("+B")).await?;

If the MODE is not given (e.g. None), then the client will send “MODE target”

NAMES(String, Option<String>)

Tuple Fields

0: String

Channel

1: Option<String>

Server to foreward request to

List all nicknames visiable to the Client

client.names("#main,#circe", None).await?;

OPER(String, String)

Tuple Fields

0: String

Username

1: String

Password

Attempts to identify as a channel operator

client.oper("username", "password").await?;

OTHER(String)

Tuple Fields

0: String

Everything that is not a command

PART(String)

Tuple Fields

0: String

Target

Leave a channel

client.part("#main").await?;

PRIVMSG(String, String, String)

Tuple Fields

0: String

Source Nickname

1: String

Channel

2: String

Message

Sends a message in a channel

client.privmsg("#main", "This is an example message").await?;

QUIT(String)

Tuple Fields

0: String

Leave message

Leaves the IRC

client.quit(Some("Leaving...")).await?;

TOPIC(String, Option<String>)

Tuple Fields

0: String

Channel

1: Option<String>

Topic

Sets or gets the topic of a channel

client.topic("#main", Some("main channel")).await?;

Implementations

impl Command

pub async fn command_from_str(s: &str) -> Self

Creates a Command from a &str. Currently only [PING] and [PRIVMSG] are supported.

Panics

This function will panic if the IRCd sends malformed messages. Please contact the maintainer of your IRCd if this happens.

Trait Implementations

impl Debug for Command

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

Formats the value using the given formatter.