Struct goldenscript::Command

#[non_exhaustive]
pub struct Command {
    pub name: String,
    pub args: Vec<Argument>,
    pub prefix: Option<String>,
    pub silent: bool,
    pub fail: bool,
    pub line_number: u32,
}

A command.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

The name of the command. Never empty.

args: Vec<Argument>

The command’s arguments, in the given order.

prefix: Option<String>

The command prefix, if given.

silent: bool

Silences the output of this command. This is handled automatically, the Runner does not have to take this into account.

fail: bool

If true, the command is expected to fail with a panic or error. If the command does not fail, the test fails.

line_number: u32

The command’s line number position in the script.

Implementations

impl Command

pub fn consume_args(&self) -> ArgumentConsumer<'_>

Returns an argument consumer, for more convenient argument processing. Does not affect Command::args.

See the module documentation for usage examples.

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 PartialEq 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: &Rhs) -> bool

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

impl StructuralPartialEq for Command