Struct CommandSyntaxError 

pub(crate) struct CommandSyntaxError {
    kind: CommandSyntaxErrorKind,
    context: Option<CommandErrorContext>,
}

A Brigadier-compatible parsing error with input context.

Dynamic floating-point values use Rust’s standard display formatting; parsing and bounds behavior remain Brigadier-compatible.

Fields

kind: CommandSyntaxErrorKind

context: Option<CommandErrorContext>

Implementations

impl CommandSyntaxError

pub(super) fn new( kind: CommandSyntaxErrorKind, input: &str, cursor: usize, byte_cursor: usize, ) -> Self

pub(crate) fn dynamic(message: impl Into<TextComponent>) -> Self

Creates a runtime command failure without parser input context.

pub(crate) const fn kind(&self) -> &CommandSyntaxErrorKind

Returns the specific built-in error.

pub(crate) fn input(&self) -> Option<&str>

Returns the command input that failed.

pub(crate) const fn cursor(&self) -> Option<usize>

Returns the failure position in UTF-16 code units.

pub(crate) fn raw_message(&self) -> String

Returns the error message without input context.

pub(crate) fn message_component(&self) -> TextComponent

Returns the vanilla translatable component for this error.

pub(crate) fn context_component(&self) -> Option<TextComponent>

Builds vanilla’s styled, clickable parser-context line.

pub(crate) fn context(&self) -> Option<String>

Returns the input immediately before the error marker.

Trait Implementations

impl Clone for CommandSyntaxError

fn clone(&self) -> CommandSyntaxError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandSyntaxError

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

Formats the value using the given formatter.

impl Display for CommandSyntaxError

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

Formats the value using the given formatter.

impl Error for CommandSyntaxError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<CommandSyntaxError> for CommandError

fn from(inner: CommandSyntaxError) -> Self

Converts to this type from the input type.

impl PartialEq for CommandSyntaxError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CommandSyntaxError