Struct Command 

pub struct Command {
    pub name: &'static str,
    pub arguments: Vec<&'static str>,
    pub description: &'static str,
    pub documentation: &'static str,
    pub scope: CommandScope,
    pub action: CommandAction,
}

Represents a sued editing command.

Commands can be defined anywhere in the program, but must be added to a CommandRegistry to make them accessible.

Fields

name: &'static str

The name of the command to execute using run_sued_command or in the REPL. This should ideally be lowercase with no separations (no camelCase or snake_case).

arguments: Vec<&'static str>

The arguments that the command takes. This is PURELY VISUAL and does not control the arguments the command uses. You are expected to manually handle command-line arguments in the action definition.

description: &'static str

A description of what the command does. This will be printed in the ~help command.

documentation: &'static str

A more expansive description of what the command does. This will be printed in the ~help <command> and ~doc <command> commands.

scope: CommandScope

The scope of the command. For more information about command scope, see the CommandScope enum.

action: CommandAction

The action that running the command uses. For more information about command actions, see the CommandAction struct.

Implementations

impl Command

pub fn new() -> Command

Creates a new Command with default values.

This should not be called and is only here for convention. Create a new Command and instantiate each field manually instead.

pub fn matches(&self, command: &str) -> bool

pub fn to_string(&self) -> String

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a duplicate 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 Default for Command

fn default() -> Command

Returns the “default value” for a type.

impl Display for Command

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

Formats the value using the given formatter.

impl Ord for Command

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Command

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

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

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

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Command