Struct CommandReader 

pub struct CommandReader<'reader, 'input> {
    inner: &'reader mut StringReader<'input>,
}

Cursor-aware input available to custom argument parsers.

Fields

inner: &'reader mut StringReader<'input>

Implementations

impl<'input> CommandReader<'_, 'input>

pub const fn input(&self) -> &'input str

Returns the complete command input.

pub const fn cursor(&self) -> usize

Returns the current UTF-8 byte cursor.

pub fn remaining(&self) -> &'input str

Returns the unconsumed input.

pub fn peek(&self) -> Option<char>

Peeks at the next Unicode scalar without consuming it.

pub fn read(&mut self) -> Option<char>

Consumes and returns the next Unicode scalar.

pub fn skip_whitespace(&mut self)

Consumes Java-compatible command whitespace.

pub fn read_unquoted_string(&mut self) -> &'input str

Reads one unquoted Brigadier string.

pub fn read_string(&mut self) -> Result<String, CommandError>

Reads one quoted or unquoted Brigadier string.

pub fn read_integer(&mut self) -> Result<i32, CommandError>

Reads a signed 32-bit integer.

pub fn read_long(&mut self) -> Result<i64, CommandError>

Reads a signed 64-bit integer.

pub fn read_float(&mut self) -> Result<f32, CommandError>

Reads a 32-bit floating-point value.

pub fn read_double(&mut self) -> Result<f64, CommandError>

Reads a 64-bit floating-point value.

pub fn read_boolean(&mut self) -> Result<bool, CommandError>

Reads a lowercase boolean.

pub fn expect(&mut self, expected: char) -> Result<(), CommandError>

Consumes one required symbol.

pub const fn checkpoint(&self) -> CommandReaderCursor

Captures the current cursor for speculative parsing.

pub const fn restore(&mut self, checkpoint: CommandReaderCursor)

Restores a previously captured cursor.

pub fn error(&self, message: impl Into<TextComponent>) -> CommandError

Creates an error carrying the reader’s current Brigadier context.