Enum ellidri_tokens::Command

pub enum Command {
    Admin,
    Authenticate,
    Away,
    Cap,
    Info,
    Invite,
    Join,
    Kick,
    Kill,
    List,
    Lusers,
    Mode,
    Motd,
    Names,
    Nick,
    Notice,
    Oper,
    Part,
    Pass,
    Ping,
    Pong,
    PrivMsg,
    Quit,
    Rehash,
    SetName,
    TagMsg,
    Time,
    Topic,
    User,
    Version,
    Who,
    Whois,
    Reply(&'static str),
}

The list of known commands.

Unknown commands and replies are supported by Message directly, this enum just contains the supported commands.

Variants

Admin

Authenticate

Away

Cap

Info

Invite

Join

Kick

Kill

List

Lusers

Mode

Motd

Names

Nick

Notice

Oper

Part

Pass

Ping

Pong

PrivMsg

Quit

Rehash

SetName

TagMsg

Time

Topic

User

Version

Who

Whois

Reply(&'static str)

Methods

impl Command

pub fn parse(s: &str) -> Option<Self>

From a given command string, returns the corresponding command, or None otherwise.

It ignores the case of its argument.

Example

let join = Command::parse("join");
let join2 = Command::parse("JOIN");
let not_join = Command::parse("not_join");

assert_eq!(join, Some(Command::Join));
assert_eq!(join2, Some(Command::Join));
assert_eq!(not_join, None);

pub fn required_params(&self) -> usize

Returns the number of required arguments for the command.

The command may accept more arguments.

Example

let privmsg = Command::parse("Privmsg").unwrap();
let topic = Command::parse("TOPIC").unwrap();

assert_eq!(privmsg.required_params(), 2);
assert_eq!(topic.required_params(), 1);

pub fn as_str(&self) -> &'static str

Returns the command string. It is not the string that have been parsed.

Example

let quit = Command::parse("Quit").unwrap();

assert_eq!(quit.as_str(), "QUIT");

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Command

impl Debug for Command

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

Formats the value using the given formatter.

impl Display for Command

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

Formats the value using the given formatter.

impl From<&'static str> for Command

fn from(reply: &'static str) -> Self

&'static strs are converted to the Command::Reply variant.

This trait is used by Buffer to accept both Command and Reply when building messages.

impl PartialEq<Command> for Command

fn eq(&self, other: &Command) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Command) -> bool

This method tests for !=.

impl StructuralPartialEq for Command