pub enum Token {
Show 283 variants
DocCommentVerifiedInner(String),
DocCommentVerified(String),
DocCommentReportedInner(String),
DocCommentReported(String),
DocCommentUncertainInner(String),
DocCommentUncertain(String),
DocCommentPredictedInner(String),
DocCommentPredicted(String),
DocCommentParadoxInner(String),
DocCommentParadox(String),
DocComment(String),
LineComment(String),
TildeComment(String),
BlockComment(String),
DeprecatedRustKeyword(String),
DeprecatedAmpMut,
Fn,
Async,
Let,
Mut,
Const,
Linear,
Affine,
Relevant,
Type,
Struct,
Enum,
Trait,
Impl,
Mod,
Use,
Pub,
Actor,
Saga,
Scope,
Rune,
Macro,
MacroRules,
If,
Else,
Match,
Loop,
While,
Return,
Yield,
Await,
SelfLower,
SelfUpper,
Super,
Crate,
Where,
As,
Dyn,
Move,
Ref,
Static,
Unsafe,
Extern,
Asm,
Volatile,
Naked,
Packed,
Simd,
Atomic,
Derive,
On,
Alter,
Switch,
Headspace,
CoCon,
Reality,
Split,
Trigger,
Layer,
Location,
States,
Anima,
To,
From,
AlterSourceFronting,
AlterSourceCoCon,
AlterSourceDormant,
AlterSourceBlended,
True,
False,
Null,
Tau,
Phi,
Sigma,
Rho,
Lambda,
LambdaExpr,
Pi,
Delta,
Epsilon,
Omega,
Alpha,
Zeta,
Mu,
Chi,
Nu,
Xi,
Psi,
Theta,
Kappa,
Parallel,
Gpu,
Convolve,
ForAll,
Exists,
ElementOf,
NotElementOf,
Union,
Intersection,
SetMinus,
Subset,
SubsetEq,
Superset,
SupersetEq,
LogicAnd,
LogicOr,
LogicNot,
LogicXor,
Top,
Bottom,
BitwiseAndSymbol,
BitwiseOrSymbol,
CircledDot,
TypeAnnotation,
Integral,
Partial,
Sqrt,
Cbrt,
Nabla,
GradeUp,
GradeDown,
Rotate,
CycleArrow,
QuadDiamond,
SquaredPlus,
Iota,
Compose,
Tensor,
DirectSum,
Bowtie,
ElementSmallVerticalBar,
SquareCup,
SquareCap,
Interrobang,
Lozenge,
BoxSquare,
LegionField,
Interfere,
Distribute,
Gather,
Broadcast,
Consensus,
DirectSumEq,
PartialEq_,
InterfereEq,
AffectNegative,
AffectNeutral,
IronyMark,
IntensityUp,
IntensityDown,
IntensityMax,
FormalRegister,
InformalRegister,
EmotionJoy,
EmotionSadness,
EmotionAnger,
EmotionFear,
EmotionSurprise,
EmotionLove,
ConfidenceHigh,
ConfidenceMedium,
ConfidenceLow,
AspectProgressive,
AspectPerfective,
AspectPotential,
AspectResultative,
Pipe,
MiddleDot,
Arrow,
FatArrow,
LeftArrow,
EqEq,
NotEq,
LtEq,
GtEq,
Lt,
Gt,
Plus,
Minus,
Star,
Slash,
Percent,
StarStar,
AndAnd,
OrOr,
Bang,
Question,
Tilde,
Amp,
Caret,
ShlEq,
ShrEq,
Shl,
Shr,
Eq,
PlusEq,
MinusEq,
StarEq,
SlashEq,
PercentEq,
PipeEq,
AmpEq,
CaretEq,
DotDot,
DotDotEq,
PlusPlus,
DeprecatedColonColon,
Colon,
Semi,
Comma,
Dot,
At,
Dollar,
HashBang,
Hash,
Underscore,
LParen,
RParen,
LBrace,
RBrace,
LBracket,
RBracket,
Empty,
Circle,
Infinity,
ProtoSend,
ProtoRecv,
ProtoStream,
ProtoConnect,
ProtoTimeout,
Send,
Recv,
Stream,
Connect,
Close,
Timeout,
Retry,
Header,
Body,
Http,
Https,
Ws,
Wss,
Grpc,
Kafka,
Amqp,
GraphQL,
BinaryLit(String),
OctalLit(String),
HexLit(String),
VigesimalLit(String),
SexagesimalLit(String),
DuodecimalLit(String),
FloatLit(String),
IntLit(String),
StringLit(String),
MultiLineStringLit(String),
ByteStringLit(Vec<u8>),
InterpolatedStringLit(String),
SigilStringSql(String),
SigilStringRoute(String),
CharLit(char),
ByteCharLit(u8),
RawStringLit(String),
RawStringDelimited(String),
Lifetime(String),
Ident(String),
RuneAnnotation(String),
}Expand description
Token types for Sigil.
Variants§
DocCommentVerifiedInner(String)
Verified doc comment: //! content (backed by test) Inner variant: //!! documents the containing module
DocCommentVerified(String)
DocCommentReportedInner(String)
Reported doc comment: //~ content (from spec/author, default) Inner variant: //~~ documents the containing module
DocCommentReported(String)
DocCommentUncertainInner(String)
Uncertain doc comment: //? content (needs investigation) Inner variant: //?? documents the containing module
DocCommentUncertain(String)
DocCommentPredictedInner(String)
Predicted doc comment: //◊ content (planned feature) Inner variant: //◊◊ documents the containing module
DocCommentPredicted(String)
DocCommentParadoxInner(String)
Paradox doc comment: //‽ content (known inconsistency) Inner variant: //‽‽ documents the containing module
DocCommentParadox(String)
DocComment(String)
LineComment(String)
TildeComment(String)
BlockComment(String)
DeprecatedRustKeyword(String)
DeprecatedAmpMut
Fn
Async
Let
Mut
Const
Linear
Affine
Relevant
Type
Struct
Enum
Trait
Impl
Mod
Use
Pub
Actor
Saga
Scope
Rune
Macro
MacroRules
If
Else
Match
Loop
While
Return
Yield
Await
SelfLower
SelfUpper
Super
Crate
Where
As
Dyn
Move
Ref
Static
Unsafe
Extern
Asm
Volatile
Naked
Packed
Simd
Atomic
Derive
On
Alter
Switch
Headspace
CoCon
Reality
Split
Trigger
Layer
Location
States
Anima
To
From
AlterSourceFronting
AlterSourceCoCon
AlterSourceDormant
AlterSourceBlended
True
False
Null
Tau
Phi
Sigma
Rho
Lambda
LambdaExpr
Pi
Delta
Epsilon
Omega
Alpha
Zeta
Mu
Chi
Nu
Xi
Psi
Theta
Kappa
Parallel
Gpu
Convolve
ForAll
Exists
ElementOf
NotElementOf
Union
Intersection
SetMinus
Subset
SubsetEq
Superset
SupersetEq
LogicAnd
LogicOr
LogicNot
LogicXor
Top
Bottom
BitwiseAndSymbol
BitwiseOrSymbol
CircledDot
TypeAnnotation
Integral
Partial
Sqrt
Cbrt
Nabla
GradeUp
GradeDown
Rotate
CycleArrow
QuadDiamond
SquaredPlus
Iota
Compose
Tensor
DirectSum
Bowtie
ElementSmallVerticalBar
SquareCup
SquareCap
Interrobang
Lozenge
BoxSquare
LegionField
Interfere
Distribute
Gather
Broadcast
Consensus
DirectSumEq
PartialEq_
InterfereEq
AffectNegative
AffectNeutral
IronyMark
IntensityUp
IntensityDown
IntensityMax
FormalRegister
InformalRegister
EmotionJoy
EmotionSadness
EmotionAnger
EmotionFear
EmotionSurprise
EmotionLove
ConfidenceHigh
ConfidenceMedium
ConfidenceLow
AspectProgressive
AspectPerfective
AspectPotential
AspectResultative
Pipe
MiddleDot
Arrow
FatArrow
LeftArrow
EqEq
NotEq
LtEq
GtEq
Lt
Gt
Plus
Minus
Star
Slash
Percent
StarStar
AndAnd
OrOr
Bang
Question
Tilde
Amp
Caret
ShlEq
ShrEq
Shl
Shr
Eq
PlusEq
MinusEq
StarEq
SlashEq
PercentEq
PipeEq
AmpEq
CaretEq
DotDot
DotDotEq
PlusPlus
DeprecatedColonColon
Colon
Semi
Comma
Dot
At
Dollar
HashBang
Hash
Underscore
LParen
RParen
LBrace
RBrace
LBracket
RBracket
Empty
Circle
Infinity
ProtoSend
ProtoRecv
ProtoStream
ProtoConnect
ProtoTimeout
Send
Recv
Stream
Connect
Close
Timeout
Retry
Header
Body
Http
Https
Ws
Wss
Grpc
Kafka
Amqp
GraphQL
BinaryLit(String)
OctalLit(String)
HexLit(String)
VigesimalLit(String)
SexagesimalLit(String)
DuodecimalLit(String)
FloatLit(String)
IntLit(String)
StringLit(String)
MultiLineStringLit(String)
ByteStringLit(Vec<u8>)
InterpolatedStringLit(String)
SigilStringSql(String)
SigilStringRoute(String)
CharLit(char)
ByteCharLit(u8)
RawStringLit(String)
RawStringDelimited(String)
Lifetime(String)
Ident(String)
RuneAnnotation(String)
Implementations§
Source§impl Token
impl Token
pub fn is_keyword(&self) -> bool
pub fn is_plurality_keyword(&self) -> bool
pub fn is_alter_source(&self) -> bool
pub fn is_morpheme(&self) -> bool
pub fn is_aspect(&self) -> bool
pub fn is_data_op(&self) -> bool
pub fn is_bitwise_symbol(&self) -> bool
pub fn is_quantifier(&self) -> bool
pub fn is_set_op(&self) -> bool
pub fn is_logic_op(&self) -> bool
pub fn is_evidentiality(&self) -> bool
pub fn is_legion_morpheme(&self) -> bool
pub fn is_legion_assign(&self) -> bool
pub fn is_affective(&self) -> bool
pub fn is_sentiment(&self) -> bool
pub fn is_emotion(&self) -> bool
pub fn is_intensity(&self) -> bool
Sourcepub fn is_doc_comment(&self) -> bool
pub fn is_doc_comment(&self) -> bool
Returns true if this token is any kind of doc comment (evidential or legacy)
Sourcepub fn is_inner_doc_comment(&self) -> bool
pub fn is_inner_doc_comment(&self) -> bool
Returns true if this is an inner doc comment (documents the enclosing item)
Sourcepub fn doc_comment_evidentiality(&self) -> Option<char>
pub fn doc_comment_evidentiality(&self) -> Option<char>
Returns the evidentiality marker for a doc comment (!, , ?, ◊, ‽)
Returns ‘’ (Reported) for legacy /// comments as default
Sourcepub fn doc_comment_content(&self) -> Option<&str>
pub fn doc_comment_content(&self) -> Option<&str>
Extracts the content string from a doc comment token
Trait Implementations§
Source§impl<'s> Logos<'s> for Token
impl<'s> Logos<'s> for Token
Source§type Error = ()
type Error = ()
#[logos(error = MyError)]. Defaults to () if not set.Source§type Extras = ()
type Extras = ()
Extras for the particular lexer. This can be set using
#[logos(extras = MyExtras)] and accessed inside callbacks.Source§type Source = str
type Source = str
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>)
fn lex(lex: &mut Lexer<'s, Self>)
Lexer. The implementation for this function
is generated by the logos-derive crate.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> 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> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§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>
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);