pub struct StringReader { /* private fields */ }Expand description
Brigadier-style string reader for parsing Minecraft commands. Tracks a cursor position and provides methods for reading various token types.
Implementations§
Source§impl StringReader
impl StringReader
pub fn new(input: &str) -> Self
pub fn cursor(&self) -> usize
pub fn set_cursor(&mut self, pos: usize)
pub fn can_read(&self) -> bool
pub fn can_read_n(&self, n: usize) -> bool
pub fn peek(&self) -> Option<char>
pub fn peek_at(&self, offset: usize) -> Option<char>
pub fn read_char(&mut self) -> Option<char>
pub fn skip_whitespace(&mut self)
pub fn skip_required_whitespace(&mut self) -> bool
pub fn remaining(&self) -> String
pub fn slice(&self, start: usize, end: usize) -> String
pub fn remaining_len(&self) -> usize
Sourcepub fn at_token_boundary(&self) -> bool
pub fn at_token_boundary(&self) -> bool
Check if the next character is whitespace or end of input (i.e., a token boundary).
Sourcepub fn try_read_literal(&mut self, literal: &str) -> bool
pub fn try_read_literal(&mut self, literal: &str) -> bool
Try to read a specific literal followed by end-of-input or whitespace.
Sourcepub fn read_unquoted_string(&mut self) -> String
pub fn read_unquoted_string(&mut self) -> String
Read an unquoted string: [a-zA-Z0-9_:.+-/#] Returns the string read, which may be empty.
Sourcepub fn read_quoted_string(&mut self) -> bool
pub fn read_quoted_string(&mut self) -> bool
Read a quoted string (“…” or ‘…’) with escape handling. Returns true if successfully read.
Sourcepub fn read_string(&mut self) -> bool
pub fn read_string(&mut self) -> bool
Read a string: if it starts with quote, read quoted; otherwise read unquoted.
Sourcepub fn read_greedy(&mut self) -> String
pub fn read_greedy(&mut self) -> String
Read everything remaining.
Sourcepub fn read_integer(&mut self) -> Option<i64>
pub fn read_integer(&mut self) -> Option<i64>
Read an integer (optional sign + digits).
Sourcepub fn read_float(&mut self) -> Option<f64>
pub fn read_float(&mut self) -> Option<f64>
Read a float/double (integer with optional decimal part and/or exponent).
Sourcepub fn read_selector(&mut self) -> bool
pub fn read_selector(&mut self) -> bool
Read a target selector: @a, @s, @p, @e, @r, optionally with […]
Sourcepub fn read_coordinate(&mut self) -> bool
pub fn read_coordinate(&mut self) -> bool
Read a coordinate value: ~, ~N, ^, ^N, or a plain number. Returns true if a coordinate was read.
Sourcepub fn try_read_macro(&mut self) -> bool
pub fn try_read_macro(&mut self) -> bool
Try to read a $(macro) placeholder. Consumes $( … ) if found.
Trait Implementations§
Source§impl Clone for StringReader
impl Clone for StringReader
Source§fn clone(&self) -> StringReader
fn clone(&self) -> StringReader
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for StringReader
impl RefUnwindSafe for StringReader
impl Send for StringReader
impl Sync for StringReader
impl Unpin for StringReader
impl UnsafeUnpin for StringReader
impl UnwindSafe for StringReader
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);