Enum Token

pub enum Token {
    Newline,
    ParenOpen,
    ParenClose,
    CurlyOpen,
    CurlyClose,
    SquareOpen,
    SquareClose,
    Bang,
    Tilde,
    Pound,
    Star,
    Question,
    Backslash,
    Percent,
    Dash,
    Equals,
    Plus,
    Colon,
    At,
    Caret,
    Slash,
    Comma,
    SingleQuote,
    DoubleQuote,
    Backtick,
    Semi,
    Amp,
    Pipe,
    AndIf,
    OrIf,
    DSemi,
    Less,
    Great,
    DLess,
    DGreat,
    GreatAnd,
    LessAnd,
    DLessDash,
    Clobber,
    LessGreat,
    Dollar,
    ParamPositional(Positional),
    Whitespace(String),
    Literal(String),
    Name(String),
}

The representation of (context free) shell tokens.

Variants

Newline

\n

ParenOpen

(

ParenClose

)

CurlyOpen

{

CurlyClose

}

SquareOpen

[

SquareClose

]

Bang

!

Tilde

~

Pound

#

Star

Question

?

Backslash

\

Percent

%

Dash

-

Equals

=

Plus

Colon

:

At

@

Caret

^

Slash

/

Comma

,

SingleQuote

’

DoubleQuote

“

Backtick

`

Semi

;

Amp

&

Pipe

|

AndIf

&&

OrIf

||

DSemi

;;

Less

<

Great

>

DLess

<<

DGreat

>>

GreatAnd

>&

LessAnd

<&

DLessDash

<<-

Clobber

>|

LessGreat

<>

Dollar

$

ParamPositional(Positional)

$0, $1, …, $9

Must be its own token to avoid lumping the positional parameter as a Literal if the parameter is concatenated to something.

Whitespace(String)

Any string of whitespace characters NOT including a newline.

Literal(String)

Any literal delimited by whitespace.

Name(String)

A Literal capable of being used as a variable or function name. According to the POSIX standard it should only contain alphanumerics or underscores, and does not start with a digit.

Implementations

impl Token

pub fn is_empty(&self) -> bool

Returns if the token’s length is zero.

pub fn len(&self) -> usize

Returns the number of characters it took to recognize a token.

pub fn is_word_delimiter(&self) -> bool

Indicates whether a word can be delimited by this token when the token is not quoted or escaped.

pub fn as_str(&self) -> &str

Gets a representation of the token as a string slice.

Trait Implementations

impl Clone for Token

fn clone(&self) -> Token

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Token

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

Formats the value using the given formatter.

impl Display for Token

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

Formats the value using the given formatter.

impl PartialEq for Token

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Token

impl StructuralPartialEq for Token