Struct comma::Command

pub struct Command {
    pub name: String,
    pub arguments: Vec<String>,
}

Contains the result of a parsed command. See [Command::from_str] documentation for details on available command syntax.

Fields

name: String

The name of the command being run (i.e. the first argument)

arguments: Vec<String>

All arguments being passed

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 Debug for Command

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

Formats the value using the given formatter.

impl FromStr for Command

type Err = EmptyCommandError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parse a command from the commandline. Commands consist of separate 'tokens' separated by whitespace.

Multiple whitespace characters are permitted between tokens, including at the beginning and end of the command string. All extra whitespace is stripped unless explicitly escaped using quotation marks or backslash escaping.

Preceding a character with a backslash (\) will cause any special meaning for the character to be ignored. To convey a real backslash in a command it must be prefixed with another backslash, such as: (\\).

Quotation marks surrounding a portion of text will also cause the text to be included verbatim, including whitespace. However, backslashes retain their special meaning, to allow for escaped quotes (\") inside a quoted string.

from_str will only fail if zero tokens are provided (i.e. there is no command name). In this case it will provide an EmptyCommandError.