Enum 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>),
    NICK(String),
    OPER(String, String),
    OTHER(String),
    PART(String),
    PING(String),
    PRIVMSG(String, String, String),
    QUIT(String),
    TOPIC(String, Option<String>),
    // some variants omitted
}

Commands that can be send or recived from an IRC server.

Variants

ADMIN(String)

Request information about the admin of a given server.

# let config = Default::default();
# let mut client = Client::new(config).await?;
# client.identify().await?;
client.admin("libera.chat").await?;
# Ok(())

Errors

Returns IO errors from the TcpStream.

Tuple Fields

0: String

Target

AWAY(String)

Set the status of the client.

# let config = Default::default();
# let mut client = Client::new(config).await?;
# client.identify().await?;
client.away("afk").await?;
# Ok(())

Tuple Fields

0: String

Message

INVITE(String, String)

Invite someone to a channel.

# let config = Default::default();
# let mut client = Client::new(config).await?;
# client.identify().await?;
client.invite("liblemonirc", "#async-circe").await?;
# Ok(())

Tuple Fields

0: String

User

1: String

Channel

JOIN(String)

Join a channel.

# let config = Default::default();
# let mut client = Client::new(config).await?;
# client.identify().await?;
client.join("#chaos").await?;
# Ok(())

Tuple Fields

0: String

Channel

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

List available channels on an IRC, or users in a channel.

# let config = Default::default();
# let mut client = Client::new(config).await?;
# client.identify().await?;
client.list(None, None).await?;
# Ok(())

Tuple Fields

0: Option<String>

Channel

1: Option<String>

Server to foreward request to

MODE(String, Option<String>)

Set the mode for a user.

# let config = Default::default();
# let mut client = Client::new(config).await?;
# client.identify().await?;
client.mode("test", Some("+B")).await?;
# Ok(())

Tuple Fields

0: String

Channel

1: Option<String>

Mode

NAMES(String, Option<String>)

Get all the people online in channels.

# let config = Default::default();
# let mut client = Client::new(config).await?;
# client.identify().await?;
client.names("#chaos,#async-circe", None).await?;
# Ok(())

Tuple Fields

0: String

Channel

1: Option<String>

Server to foreward request to

NICK(String)

Change your nickname on a server.

# let config = Default::default();
# let mut client = Client::new(config).await?;
# client.identify().await?;
client.nick("Not async-circe").await?;
# Ok(())

Tuple Fields

0: String

Nickname

OPER(String, String)

Authentificate as an operator on a server.

# let config = Default::default();
# let mut client = Client::new(config).await?;
# client.identify().await?;
client.oper("username", "password").await?;
# Ok(())

Tuple Fields

0: String

Username

1: String

Password

OTHER(String)

Everything that is not a command

PART(String)

Leave a channel.

# let config = Default::default();
# let mut client = Client::new(config).await?;
# client.identify().await?;
client.part("#chaos").await?;
# Ok(())

Tuple Fields

0: String

Target

PING(String)

Tests the presence of a connection to a server.

# let config = Default::default();
# let mut client = Client::new(config).await?;
# client.identify().await?;
client.ping("libera.chat", None).await?;
# Ok(())

PRIVMSG(String, String, String)

Send a message to a channel.

# let config = Default::default();
# let mut client = Client::new(config).await?;
# client.identify().await?;
client.privmsg("#chaos", "Hello").await?;
# Ok(())

Tuple Fields

0: String

Source Nickname

1: String

Channel

2: String

Message

QUIT(String)

Leave the IRC server you are connected to.

# let config = Default::default();
# let mut client = Client::new(config).await?;
# client.identify().await?;
client.quit(None).await?;
# Ok(())

Tuple Fields

0: String

Leave message

TOPIC(String, Option<String>)

Get the topic of a channel.

Example

# let config = Default::default();
# let mut client = Client::new(config).await?;
# client.identify().await?;
client.topic("#chaos", None).await?;
# Ok(())

Set the topic of a channel.

Example

# let config = Default::default();
# let mut client = Client::new(config).await?;
# client.identify().await?;
client.topic("#chaos", Some("main channel")).await?;
# Ok(())

Errors

Returns IO errors from the TcpStream.

Tuple Fields

0: String

Channel

1: Option<String>

Topic

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.