Skip to main content

CommandContext

Struct CommandContext 

Source
pub struct CommandContext {
    pub name: String,
    pub args: String,
    pub source: String,
    pub uuid: String,
}
Expand description

Details of a command invocation.

Fields§

§name: String

Command name that was run, without the leading slash.

§args: String

Raw argument string after the command name (empty if none).

§source: String

Name of the player (or console) that ran the command.

§uuid: String

UUID of the executing entity (empty if run from the console).

Implementations§

Source§

impl CommandContext

Source

pub fn arg_list(&self) -> Vec<&str>

Arguments split on whitespace — for plain (untyped) commands.

Source

pub fn typed_args(&self) -> Vec<&str>

Arguments split on \t — for typed commands registered with a schema.

Source

pub fn arg_str(&self, idx: usize) -> Option<&str>

The raw string of typed argument at idx, or None if out of range.

Source

pub fn arg_int(&self, idx: usize) -> Option<i32>

Typed argument idx parsed as i32, or None.

Source

pub fn arg_float(&self, idx: usize) -> Option<f32>

Typed argument idx parsed as f32, or None.

Source

pub fn arg_player(&self, idx: usize) -> Option<&str>

Typed argument idx as a player name, or None.

Source

pub fn arg_blockpos(&self, idx: usize) -> Option<(i32, i32, i32)>

Typed argument idx as a block position ("x,y,z"), or None.

Trait Implementations§

Source§

impl Clone for CommandContext

Source§

fn clone(&self) -> CommandContext

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CommandContext

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.