Enum CommandArgumentKind 

#[non_exhaustive]
pub enum CommandArgumentKind {
    Word,
    Greedy,
}

How much of the command line a custom argument’s value takes.

The server and a client that does not know the type parse the value as this before the mod’s own parser sees it, so the type must say it up front, when it is registered.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Word

One word, as Brigadier’s word string: ASCII letters and digits, and _ - . +. The word ends at the first other character, a space included, so a value containing : or / needs Greedy as the usage’s last argument.

Greedy

The rest of the line, spaces included: the argument must be the usage’s last.

Trait Implementations

impl Clone for CommandArgumentKind

fn clone(&self) -> CommandArgumentKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CommandArgumentKind

impl Debug for CommandArgumentKind

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

Formats the value using the given formatter.

impl Default for CommandArgumentKind

fn default() -> CommandArgumentKind

Returns the “default value” for a type.

impl Eq for CommandArgumentKind

impl PartialEq for CommandArgumentKind

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CommandArgumentKind

impl Wire for CommandArgumentKind

const MIN: usize = 4usize

Minimum encoded size, used to reject impossible collection lengths.

fn put(&self, out: &mut Writer)

Encodes this value, recording failures on the writer.

fn put_owned(self, out: &mut Writer)

Consumes owned data when a resource’s ownership must cross the boundary.

fn take(input: &mut Reader<'_>) -> Result<CommandArgumentKind, WireError>

Decodes one value, leaving any following bytes for the caller.