Skip to main content

Token

Enum Token 

Source
pub enum Token {
Show 89 variants Set, Local, If, Then, Else, Elif, Fi, For, While, In, Do, Done, Case, Esac, Function, Break, Continue, Return, Exit, True, False, TypeString, TypeInt, TypeFloat, TypeBool, And, Or, EqEq, NotEq, Match, NotMatch, GtEq, LtEq, GtGt, StderrToStdout, StdoutToStderr, StdoutToStderr2, Stderr, Both, HereDocStart, DoubleSemi, Eq, Pipe, Amp, Gt, Lt, Semi, Colon, Comma, Dot, LBrace, RBrace, LBracket, RBracket, LParen, RParen, Star, Bang, Question, Arithmetic(String), CmdSubstStart, LongFlag(String), ShortFlag(String), PlusFlag(String), DoubleDash, PlusBare(String), MinusBare(String), MinusAlone, String(String), SingleString(String), VarRef(String), SimpleVarRef(String), Positional(usize), AllArgs, ArgCount, LastExitCode, CurrentPid, VarLength(String), HereDoc(HereDocData), Int(i64), Float(f64), InvalidNumberIdent, InvalidFloatNoLeading, InvalidFloatNoTrailing, Path(String), Ident(String), Comment, Newline, LineContinuation,
}

Variants§

§

Set

§

Local

§

If

§

Then

§

Else

§

Elif

§

Fi

§

For

§

While

§

In

§

Do

§

Done

§

Case

§

Esac

§

Function

§

Break

§

Continue

§

Return

§

Exit

§

True

§

False

§

TypeString

§

TypeInt

§

TypeFloat

§

TypeBool

§

And

§

Or

§

EqEq

§

NotEq

§

Match

§

NotMatch

§

GtEq

§

LtEq

§

GtGt

§

StderrToStdout

§

StdoutToStderr

§

StdoutToStderr2

§

Stderr

§

Both

§

HereDocStart

§

DoubleSemi

§

Eq

§

Pipe

§

Amp

§

Gt

§

Lt

§

Semi

§

Colon

§

Comma

§

Dot

§

LBrace

§

RBrace

§

LBracket

§

RBracket

§

LParen

§

RParen

§

Star

§

Bang

§

Question

§

Arithmetic(String)

Arithmetic expression content: synthesized by preprocessing. Contains the expression string between $(( and )).

§

CmdSubstStart

Command substitution start: $( - begins a command substitution

§

LongFlag(String)

Long flag: --name or --foo-bar

§

ShortFlag(String)

Short flag: -l or -la (combined short flags)

§

PlusFlag(String)

Plus flag: +e or +x (for set +e to disable options)

§

DoubleDash

Double dash: -- alone marks end of flags

§

PlusBare(String)

Bare word starting with + followed by non-letter: +%s, +%Y-%m-%d For date format strings and similar. Lower priority than PlusFlag.

§

MinusBare(String)

Bare word starting with - followed by non-letter/digit/dash: -%, etc. For rare cases. Lower priority than ShortFlag, Int, and DoubleDash. Excludes - after first - to avoid matching –name patterns.

§

MinusAlone

Standalone - (stdin indicator for cat -, diff - -, etc.) Only matches when followed by whitespace or end. This is handled specially in the parser as a positional arg.

§

String(String)

Double-quoted string: "..." - value is the parsed content (quotes removed, escapes processed)

§

SingleString(String)

Single-quoted string: '...' - literal content, no escape processing

§

VarRef(String)

Braced variable reference: ${VAR} or ${VAR.field} - value is the raw inner content

§

SimpleVarRef(String)

Simple variable reference: $NAME - just the identifier

§

Positional(usize)

Positional parameter: $0 through $9

§

AllArgs

All positional parameters: $@

§

ArgCount

Number of positional parameters: $#

§

LastExitCode

Last exit code: $?

§

CurrentPid

Current shell PID: $$

§

VarLength(String)

Variable string length: ${#VAR}

§

HereDoc(HereDocData)

Here-doc content: synthesized by preprocessing, not directly lexed. Contains the full content of the here-doc (without the delimiter lines).

§

Int(i64)

Integer literal - value is the parsed i64

§

Float(f64)

Float literal - value is the parsed f64

§

InvalidNumberIdent

Invalid: number followed by identifier characters (like 123abc)

§

InvalidFloatNoLeading

Invalid: float without leading digit (like .5)

§

InvalidFloatNoTrailing

Invalid: float without trailing digit (like 5.) Logos uses longest-match, so valid floats like 5.5 will match Float pattern instead

§

Path(String)

Absolute path: /tmp/out, /etc/hosts, etc.

§

Ident(String)

Identifier - value is the identifier string Allows dots for filenames like script.kai

§

Comment

Comment: # ... to end of line

§

Newline

Newline (significant in kaish - ends statements)

§

LineContinuation

Line continuation: backslash at end of line

Implementations§

Source§

impl Token

Source

pub fn category(&self) -> TokenCategory

Returns the semantic category for syntax highlighting.

Source§

impl Token

Source

pub fn is_keyword(&self) -> bool

Returns true if this token is a keyword.

Source

pub fn is_type(&self) -> bool

Returns true if this token is a type keyword.

Source

pub fn starts_statement(&self) -> bool

Returns true if this token starts a statement.

Source

pub fn is_value(&self) -> bool

Returns true if this token can appear in an expression.

Trait Implementations§

Source§

impl Clone for Token

Source§

fn clone(&self) -> Token

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Token

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Token

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'s> Logos<'s> for Token

Source§

type Error = LexerError

Error type returned by the lexer. This can be set using #[logos(error = MyError)]. Defaults to () if not set.
Source§

type Extras = ()

Associated type Extras for the particular lexer. This can be set using #[logos(extras = MyExtras)] and accessed inside callbacks.
Source§

type Source = str

Source type this token can be lexed from. This will default to str, unless one of the defined patterns explicitly uses non-unicode byte values or byte slices, in which case that implementation will use [u8].
Source§

fn lex( lex: &mut Lexer<'s, Self>, ) -> Option<Result<Self, <Self as Logos<'s>>::Error>>

The heart of Logos. Called by the Lexer. The implementation for this function is generated by the logos-derive crate.
Source§

fn lexer(source: &'source Self::Source) -> Lexer<'source, Self>
where Self::Extras: Default,

Create a new instance of a Lexer that will produce tokens implementing this Logos.
Source§

fn lexer_with_extras( source: &'source Self::Source, extras: Self::Extras, ) -> Lexer<'source, Self>

Create a new instance of a Lexer with the provided Extras that will produce tokens implementing this Logos.
Source§

impl PartialEq for Token

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Token

Auto Trait Implementations§

§

impl Freeze for Token

§

impl RefUnwindSafe for Token

§

impl Send for Token

§

impl Sync for Token

§

impl Unpin for Token

§

impl UnwindSafe for Token

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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<'src, T> IntoMaybe<'src, T> for T
where T: 'src,

Source§

type Proj<U: 'src> = U

Source§

fn map_maybe<R>( self, _f: impl FnOnce(&'src T) -> &'src R, g: impl FnOnce(T) -> R, ) -> <T as IntoMaybe<'src, T>>::Proj<R>
where R: 'src,

Source§

impl<'p, T> Seq<'p, T> for T
where T: Clone,

Source§

type Item<'a> = &'a T where T: 'a

The item yielded by the iterator.
Source§

type Iter<'a> = Once<&'a T> where T: 'a

An iterator over the items within this container, by reference.
Source§

fn seq_iter(&self) -> <T as Seq<'p, T>>::Iter<'_>

Iterate over the elements of the container.
Source§

fn contains(&self, val: &T) -> bool
where T: PartialEq,

Check whether an item is contained within this sequence.
Source§

fn to_maybe_ref<'b>(item: <T as Seq<'p, T>>::Item<'b>) -> Maybe<T, &'p T>
where 'p: 'b,

Convert an item of the sequence into a MaybeRef.
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> OrderedSeq<'_, T> for T
where T: Clone,