Struct CommandArgument

pub struct CommandArgument {
    pub untrimmed: String,
    pub text: String,
}

Argument text following a command name.

Fields

untrimmed: String

Original text of the command argument.

text: String

Argument to the command with leading spaces stripped.

Implementations

impl CommandArgument

pub fn filenames<W>(&self) -> Result<Vec<OpenTarget<W>>, CommandError>

where W: ApplicationWindowId,

Interpret the argument text as a collection of filenames.

This is similar to CommandArgument::strings, but in addition to processing escaped spaces and quoted strings, this will:

• turn lone # characters into OpenTarget::Alternate
• turn lone % characters into OpenTarget::Current

These values can be escaped. For example, \# will become OpenTarget::Name("#").

pub fn strings(&self) -> Result<Vec<String>, CommandError>

Interpret the argument text as a collection of strings.

Values containing spaces can either be quoted, or escaped with a backslash. (For example, My\ File.txt or `“My File.txt”)

pub fn options(&self) -> Result<Vec<OptionType>, CommandError>

Interpret the argument text as a series of positional arguments and flags starting with ++.

pub fn range(&self) -> Result<RangeSpec, CommandError>

Interpret the argument text as a range specification.

This can be used to create commands that take a range specification either before or after the command name.

Trait Implementations

impl Debug for CommandArgument

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

Formats the value using the given formatter.

impl PartialEq for CommandArgument

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CommandArgument

impl StructuralPartialEq for CommandArgument