Struct Command 

#[non_exhaustive]
pub struct Command {
    pub usage: String,
    pub level: u8,
}

A command a native mod adds, as one usage: words, then arguments <name:kind>, optional ones last in brackets [name:kind]: pay <player:player> <amount:integer>, balance [player:player], eco give <player:player> <amount:integer>. Kinds: word, text (the rest of the line, last), integer, number, boolean, player, item, block_pos, or a command argument type a mod registered with Registrar::register_command_argument, named by its namespaced id: machine use <machine:mymod:machine>. Usages of one command share their words; the server merges them into one tree. Each executable usage keeps its own level: a public foo bar lets everyone traverse foo, but does not make an operator-only foo executable. Optional arguments also allow execution at their preceding prefixes, at that usage’s level.

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.

usage: String

The usage.

level: u8

The operator level a player needs to run this usage (0: everyone). Shared prefixes stay visible when needed to reach a lower-level usage.

Implementations

impl Command

pub fn new(usage: &str) -> Command

A usage every player may run.

pub fn op(usage: &str, level: u8) -> Command

The same, for operators of level and above.

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<(), Error>

Formats the value using the given formatter.

impl Eq for Command

impl PartialEq for Command

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Command

impl Wire for Command

const MIN: usize

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<Command, WireError>

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