Skip to main content

Token

Enum Token 

Source
pub enum Token {
Show 397 variants Error(), Always(), And(), Assign(), Begin(), Buf(), Bufif0(), Bufif1(), Case(), Casex(), Casez(), Cmos(), Deassign(), Default(), Defparam(), Disable(), Edge(), Else(), End(), Endcase(), Endfunction(), Endmodule(), Endprimitive(), Endspecify(), Endtable(), Endtask(), Event(), For(), Force(), Forever(), Fork(), Function(), Highz0(), Highz1(), If(), Ifnone(), Initial(), Inout(), Input(), Integer(), Join(), Large(), Macromodule(), Medium(), Module(), Nand(), Negedge(), Nmos(), Nor(), Not(), Notif0(), Notif1(), Or(), Output(), Parameter(), Pmos(), Posedge(), Primitive(), Pull0(), Pull1(), Pulldown(), Pullup(), Rcmos(), Real(), Realtime(), Reg(), Release(), Repeat(), Rnmos(), Rpmos(), Rtran(), Rtranif0(), Rtranif1(), Scalared(), Small(), Specify(), Specparam(), Strong0(), Strong1(), Supply0(), Supply1(), Table(), Task(), Time(), Tran(), Tranif0(), Tranif1(), Tri(), Tri0(), Tri1(), Triand(), Trior(), Trireg(), Vectored(), Wait(), Wand(), Weak0(), Weak1(), While(), Wire(), Wor(), Xnor(), Xor(), Automatic(), Cell(), Config(), Design(), Endconfig(), Endgenerate(), Generate(), Genvar(), Incdir(), Include(), Instance(), Liblist(), Library(), Localparam(), Noshowcancelled(), PulsestyleOndetect(), PulsestyleOnevent(), Showcancelled(), Signed(), Unsigned(), Use(), Uwire(), Alias(), AlwaysComb(), AlwaysFf(), AlwaysLatch(), Assert(), Assume(), Before(), Bind(), Bins(), Binsof(), Bit(), Break(), Byte(), Chandle(), Class(), Clocking(), Const(), Constraint(), Context(), Continue(), Cover(), Covergroup(), Coverpoint(), Cross(), Dist(), Do(), Endclass(), Endclocking(), Endgroup(), Endinterface(), Endpackage(), Endprogram(), Endproperty(), Endsequence(), Enum(), Expect(), Export(), Extends(), Extern(), Final(), FirstMatch(), Foreach(), Forkjoin(), Iff(), IgnoreBins(), IllegalBins(), Import(), Inside(), Int(), Interface(), Intersect(), JoinAny(), JoinNone(), Local(), Logic(), Longint(), Matches(), Modport(), New(), Null(), Package(), Packed(), Priority(), Program(), Property(), Protected(), Pure(), Rand(), Randc(), Randcase(), Randsequence(), Ref(), Return(), Sequence(), Shortint(), Shortreal(), Solve(), Static(), String(), Struct(), Super(), Tagged(), This(), Throughout(), Timeprecision(), Timeunit(), Type(), Typedef(), Union(), Unique(), Var(), Virtual(), Void(), WaitOrder(), Wildcard(), With(), Within(), AcceptOn(), Checker(), Endchecker(), Eventually(), Global(), Implies(), Let(), Nexttime(), RejectOn(), Restrict(), SAlways(), SEventually(), SNexttime(), SUntil(), SUntilWith(), Strong(), SyncAcceptOn(), SyncRejectOn(), Unique0(), Until(), UntilWith(), Untyped(), Weak(), Implements(), Interconnect(), Nettype(), Soft(), DirUnderscoreFile(), DirUnderscoreLine(), DirBeginKeywords(), DirCelldefine(), DirDefaultNettype(), DirDefine(), DirElse(), DirElsif(), DirEndKeywords(), DirEndcelldefine(), DirEndif(), DirIfdef(), DirIfndef(), DirInclude(), DirLine(), DirNounconnectedDrive(), DirPragma(), DirResetall(), DirTimescale(), DirUnconnectedDrive(), DirUndef(), DirUndefineall(), Plus(), Minus(), Exclamation(), Quest(), Tilde(), Amp(), TildeAmp(), Pipe(), TildePipe(), Caret(), TildeCaret(), CaretTilde(), Star(), Slash(), Percent(), EqEq(), ExclEq(), PlusEq(), MinusEq(), StarEq(), SlashEq(), PercentEq(), AmpEq(), PipeEq(), CaretEq(), EqEqEq(), ExclEqEq(), EqEqQuest(), ExclEqQuest(), AmpAmp(), AmpAmpAmp(), PipePipe(), StarStar(), Lt(), LtEq(), Gt(), GtEq(), GtGt(), LtLt(), GtGtEq(), LtLtEq(), GtGtGt(), LtLtLt(), GtGtGtEq(), LtLtLtEq(), MinusGt(), MinusGtGt(), LtMinusGt(), PlusPlus(), MinusMinus(), PlusColon(), MinusColon(), PlusSlashMinus(), PlusPercentMinus(), Paren(), EParen(), Bracket(), EBracket(), Brace(), EBrace(), Colon(), SColon(), Apost(), Comma(), Period(), Pound(), Dollar(), At(), AtAt(), Eq(), ColonColon(), ColonEq(), ColonSlash(), PoundPound(), PoundMinusPound(), PoundEqPound(), EqGt(), StarGt(), PipeMinusGt(), PipeEqGt(), Bslash(), Std(), PathpulseDollar(), Option(), TypeOption(), Randomize(), Sample(), OneStep(), DollarSetup(), DollarHold(), DollarSetuphold(), DollarRecovery(), DollarRemoval(), DollarRecrem(), DollarSkew(), DollarTimeskew(), DollarFullskew(), DollarPeriod(), DollarWidth(), DollarNochange(), DollarRoot(), DollarUnit(), DollarFatal(), DollarError(), DollarWarning(), DollarInfo(), OnelineComment { text: String, }, BlockComment { text: String, }, UnsignedNumber { text: String, }, FixedPointNumber { text: String, }, BinaryNumber { text: String, }, OctalNumber { text: String, }, DecimalNumber { text: String, }, HexNumber { text: String, }, ScientificNumber { text: String, }, UnbasedUnsizedLiteral { text: String, }, SystemTfIdentifier { text: String, }, SimpleIdentifier { text: String, }, EscapedIdentifier { text: String, }, PreprocessorIdentifier { text: String, }, TextMacro { text: String, }, StringLiteral { text: String, }, PreprocessorStringLiteral { text: String, }, TripleQuoteStringLiteral { text: String, }, PreprocessorTripleQuoteStringLiteral { text: String, }, Newline(),
}
Expand description

A wrapper around scarf_parser::Token

Variants§

§

Error()

§

Always()

§

And()

§

Assign()

§

Begin()

§

Buf()

§

Bufif0()

§

Bufif1()

§

Case()

§

Casex()

§

Casez()

§

Cmos()

§

Deassign()

§

Default()

§

Defparam()

§

Disable()

§

Edge()

§

Else()

§

End()

§

Endcase()

§

Endfunction()

§

Endmodule()

§

Endprimitive()

§

Endspecify()

§

Endtable()

§

Endtask()

§

Event()

§

For()

§

Force()

§

Forever()

§

Fork()

§

Function()

§

Highz0()

§

Highz1()

§

If()

§

Ifnone()

§

Initial()

§

Inout()

§

Input()

§

Integer()

§

Join()

§

Large()

§

Macromodule()

§

Medium()

§

Module()

§

Nand()

§

Negedge()

§

Nmos()

§

Nor()

§

Not()

§

Notif0()

§

Notif1()

§

Or()

§

Output()

§

Parameter()

§

Pmos()

§

Posedge()

§

Primitive()

§

Pull0()

§

Pull1()

§

Pulldown()

§

Pullup()

§

Rcmos()

§

Real()

§

Realtime()

§

Reg()

§

Release()

§

Repeat()

§

Rnmos()

§

Rpmos()

§

Rtran()

§

Rtranif0()

§

Rtranif1()

§

Scalared()

§

Small()

§

Specify()

§

Specparam()

§

Strong0()

§

Strong1()

§

Supply0()

§

Supply1()

§

Table()

§

Task()

§

Time()

§

Tran()

§

Tranif0()

§

Tranif1()

§

Tri()

§

Tri0()

§

Tri1()

§

Triand()

§

Trior()

§

Trireg()

§

Vectored()

§

Wait()

§

Wand()

§

Weak0()

§

Weak1()

§

While()

§

Wire()

§

Wor()

§

Xnor()

§

Xor()

§

Automatic()

§

Cell()

§

Config()

§

Design()

§

Endconfig()

§

Endgenerate()

§

Generate()

§

Genvar()

§

Incdir()

§

Include()

§

Instance()

§

Liblist()

§

Library()

§

Localparam()

§

Noshowcancelled()

§

PulsestyleOndetect()

§

PulsestyleOnevent()

§

Showcancelled()

§

Signed()

§

Unsigned()

§

Use()

§

Uwire()

§

Alias()

§

AlwaysComb()

§

AlwaysFf()

§

AlwaysLatch()

§

Assert()

§

Assume()

§

Before()

§

Bind()

§

Bins()

§

Binsof()

§

Bit()

§

Break()

§

Byte()

§

Chandle()

§

Class()

§

Clocking()

§

Const()

§

Constraint()

§

Context()

§

Continue()

§

Cover()

§

Covergroup()

§

Coverpoint()

§

Cross()

§

Dist()

§

Do()

§

Endclass()

§

Endclocking()

§

Endgroup()

§

Endinterface()

§

Endpackage()

§

Endprogram()

§

Endproperty()

§

Endsequence()

§

Enum()

§

Expect()

§

Export()

§

Extends()

§

Extern()

§

Final()

§

FirstMatch()

§

Foreach()

§

Forkjoin()

§

Iff()

§

IgnoreBins()

§

IllegalBins()

§

Import()

§

Inside()

§

Int()

§

Interface()

§

Intersect()

§

JoinAny()

§

JoinNone()

§

Local()

§

Logic()

§

Longint()

§

Matches()

§

Modport()

§

New()

§

Null()

§

Package()

§

Packed()

§

Priority()

§

Program()

§

Property()

§

Protected()

§

Pure()

§

Rand()

§

Randc()

§

Randcase()

§

Randsequence()

§

Ref()

§

Return()

§

Sequence()

§

Shortint()

§

Shortreal()

§

Solve()

§

Static()

§

String()

§

Struct()

§

Super()

§

Tagged()

§

This()

§

Throughout()

§

Timeprecision()

§

Timeunit()

§

Type()

§

Typedef()

§

Union()

§

Unique()

§

Var()

§

Virtual()

§

Void()

§

WaitOrder()

§

Wildcard()

§

With()

§

Within()

§

AcceptOn()

§

Checker()

§

Endchecker()

§

Eventually()

§

Global()

§

Implies()

§

Let()

§

Nexttime()

§

RejectOn()

§

Restrict()

§

SAlways()

§

SEventually()

§

SNexttime()

§

SUntil()

§

SUntilWith()

§

Strong()

§

SyncAcceptOn()

§

SyncRejectOn()

§

Unique0()

§

Until()

§

UntilWith()

§

Untyped()

§

Weak()

§

Implements()

§

Interconnect()

§

Nettype()

§

Soft()

§

DirUnderscoreFile()

§

DirUnderscoreLine()

§

DirBeginKeywords()

§

DirCelldefine()

§

DirDefaultNettype()

§

DirDefine()

§

DirElse()

§

DirElsif()

§

DirEndKeywords()

§

DirEndcelldefine()

§

DirEndif()

§

DirIfdef()

§

DirIfndef()

§

DirInclude()

§

DirLine()

§

DirNounconnectedDrive()

§

DirPragma()

§

DirResetall()

§

DirTimescale()

§

DirUnconnectedDrive()

§

DirUndef()

§

DirUndefineall()

§

Plus()

§

Minus()

§

Exclamation()

§

Quest()

§

Tilde()

§

Amp()

§

TildeAmp()

§

Pipe()

§

TildePipe()

§

Caret()

§

TildeCaret()

§

CaretTilde()

§

Star()

§

Slash()

§

Percent()

§

EqEq()

§

ExclEq()

§

PlusEq()

§

MinusEq()

§

StarEq()

§

SlashEq()

§

PercentEq()

§

AmpEq()

§

PipeEq()

§

CaretEq()

§

EqEqEq()

§

ExclEqEq()

§

EqEqQuest()

§

ExclEqQuest()

§

AmpAmp()

§

AmpAmpAmp()

§

PipePipe()

§

StarStar()

§

Lt()

§

LtEq()

§

Gt()

§

GtEq()

§

GtGt()

§

LtLt()

§

GtGtEq()

§

LtLtEq()

§

GtGtGt()

§

LtLtLt()

§

GtGtGtEq()

§

LtLtLtEq()

§

MinusGt()

§

MinusGtGt()

§

LtMinusGt()

§

PlusPlus()

§

MinusMinus()

§

PlusColon()

§

MinusColon()

§

PlusSlashMinus()

§

PlusPercentMinus()

§

Paren()

§

EParen()

§

Bracket()

§

EBracket()

§

Brace()

§

EBrace()

§

Colon()

§

SColon()

§

Apost()

§

Comma()

§

Period()

§

Pound()

§

Dollar()

§

At()

§

AtAt()

§

Eq()

§

ColonColon()

§

ColonEq()

§

ColonSlash()

§

PoundPound()

§

PoundMinusPound()

§

PoundEqPound()

§

EqGt()

§

StarGt()

§

PipeMinusGt()

§

PipeEqGt()

§

Bslash()

§

Std()

§

PathpulseDollar()

§

Option()

§

TypeOption()

§

Randomize()

§

Sample()

§

OneStep()

§

DollarSetup()

§

DollarHold()

§

DollarSetuphold()

§

DollarRecovery()

§

DollarRemoval()

§

DollarRecrem()

§

DollarSkew()

§

DollarTimeskew()

§

DollarFullskew()

§

DollarPeriod()

§

DollarWidth()

§

DollarNochange()

§

DollarRoot()

§

DollarUnit()

§

DollarFatal()

§

DollarError()

§

DollarWarning()

§

DollarInfo()

§

OnelineComment

Fields

§text: String
§

BlockComment

Fields

§text: String
§

UnsignedNumber

Fields

§text: String
§

FixedPointNumber

Fields

§text: String
§

BinaryNumber

Fields

§text: String
§

OctalNumber

Fields

§text: String
§

DecimalNumber

Fields

§text: String
§

HexNumber

Fields

§text: String
§

ScientificNumber

Fields

§text: String
§

UnbasedUnsizedLiteral

Fields

§text: String
§

SystemTfIdentifier

Fields

§text: String
§

SimpleIdentifier

Fields

§text: String
§

EscapedIdentifier

Fields

§text: String
§

PreprocessorIdentifier

Fields

§text: String
§

TextMacro

Fields

§text: String
§

StringLiteral

Fields

§text: String
§

PreprocessorStringLiteral

Fields

§text: String
§

TripleQuoteStringLiteral

Fields

§text: String
§

PreprocessorTripleQuoteStringLiteral

Fields

§text: String
§

Newline()

Trait Implementations§

Source§

impl Clone for Token

Source§

fn clone(&self) -> Token

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. 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 Eq for Token

Source§

impl<'a> From<&'a Token> for Token<'a>

Source§

fn from(value: &'a Token) -> Self

Converts to this type from the input type.
Source§

impl<'a> From<Token<'a>> for Token

Source§

fn from(value: Token<'a>) -> Self

Converts to this type from the input type.
Source§

impl<'a, 'py> FromPyObject<'a, 'py> for Token
where Self: Clone,

Source§

const INPUT_TYPE: PyStaticExpr = <Token as ::pyo3::PyTypeInfo>::TYPE_HINT

Provides the type hint information for this type when it appears as an argument. Read more
Source§

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error. Read more
Source§

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj. Read more
Source§

impl<'py> IntoPyObject<'py> for Token

Source§

const OUTPUT_TYPE: PyStaticExpr = <Token as ::pyo3::PyTypeInfo>::TYPE_HINT

Extracts the type hint information for this type when it appears as a return value. Read more
Source§

type Target = Token

The Python output type
Source§

type Output = Bound<'py, <Token as IntoPyObject<'py>>::Target>

The smart pointer type to use. Read more
Source§

type Error = PyErr

The type returned in the event of a conversion error.
Source§

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.
Source§

impl PartialEq for Token

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PyClass for Token

Source§

const NAME: &str = "Token"

Name of the class. Read more
Source§

type Frozen = True

Whether the pyclass is frozen. Read more
Source§

impl PyClassBaseType for Token

Source§

type LayoutAsBase = <Token as PyClassImpl>::Layout

Source§

type BaseNativeType = <Token as PyClassImpl>::BaseNativeType

Source§

type Initializer = PyClassInitializer<Token>

Source§

type PyClassMutability = <Token as PyClassImpl>::PyClassMutability

Source§

type Layout<T: PyClassImpl> = <<Token as PyClassBaseType>::BaseNativeType as PyClassBaseType>::Layout<T>

The type of object layout to use for ancestors or descendants of this type.
Source§

impl PyClassImpl for Token

Source§

const MODULE: Option<&str>

Module which the class will be associated with. Read more
Source§

const IS_BASETYPE: bool = true

#[pyclass(subclass)]
Source§

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]
Source§

const IS_MAPPING: bool = false

#[pyclass(mapping)]
Source§

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]
Source§

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]
Source§

const RAW_DOC: &'static CStr = /// A wrapper around [`scarf_parser::Token`]

Docstring for the class provided on the struct or enum. Read more
Source§

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined. Read more
Source§

type Layout = <<Token as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<Token>

Description of how this class is laid out in memory
Source§

type BaseType = PyAny

Base class
Source§

type ThreadChecker = NoopThreadChecker

This handles following two situations: Read more
Source§

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::ImmutableChild

Immutable or mutable
Source§

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.
Source§

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.
Source§

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.
Source§

fn items_iter() -> PyClassItemsIter

Source§

fn lazy_type_object() -> &'static LazyTypeObject<Self>

Source§

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)
Source§

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset
Source§

impl PyTypeInfo for Token

Source§

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.
Source§

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.
Source§

const TYPE_HINT: PyStaticExpr

Provides the full python type as a type hint.
Source§

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.
Source§

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.
Source§

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.
Source§

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.
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 UnsafeUnpin 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> Fmt for T
where T: Display,

Source§

fn fg<C>(self, color: C) -> Foreground<Self>
where C: Into<Option<Color>>, Self: Display,

Give this value the specified foreground colour.
Source§

fn bg<C>(self, color: C) -> Background<Self>
where C: Into<Option<Color>>, Self: Display,

Give this value the specified background colour.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<'py, T> FromPyObjectOwned<'py> for T
where T: for<'a> FromPyObject<'a, 'py>,

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<'py, T> IntoPyObjectExt<'py> for T
where T: IntoPyObject<'py>,

Source§

fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>

Converts self into an owned Python object, dropping type information.
Source§

fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>

Converts self into an owned Python object, dropping type information and unbinding it from the 'py lifetime.
Source§

fn into_pyobject_or_pyerr(self, py: Python<'py>) -> Result<Self::Output, PyErr>

Converts self into a Python object. Read more
Source§

impl<T> Paint for T
where T: ?Sized,

Source§

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 primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example
println!("{}", value.primary());
Source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example
println!("{}", value.fixed(color));
Source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example
println!("{}", value.rgb(r, g, b));
Source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example
println!("{}", value.black());
Source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example
println!("{}", value.red());
Source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example
println!("{}", value.green());
Source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example
println!("{}", value.yellow());
Source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example
println!("{}", value.blue());
Source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example
println!("{}", value.magenta());
Source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example
println!("{}", value.cyan());
Source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example
println!("{}", value.white());
Source§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlack].

§Example
println!("{}", value.bright_black());
Source§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightRed].

§Example
println!("{}", value.bright_red());
Source§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightGreen].

§Example
println!("{}", value.bright_green());
Source§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightYellow].

§Example
println!("{}", value.bright_yellow());
Source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example
println!("{}", value.bright_blue());
Source§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.bright_magenta());
Source§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightCyan].

§Example
println!("{}", value.bright_cyan());
Source§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightWhite].

§Example
println!("{}", value.bright_white());
Source§

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>

Returns self with the bg() set to [Color :: Primary].

§Example
println!("{}", value.on_primary());
Source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example
println!("{}", value.on_fixed(color));
Source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
Source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example
println!("{}", value.on_black());
Source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example
println!("{}", value.on_red());
Source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example
println!("{}", value.on_green());
Source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example
println!("{}", value.on_yellow());
Source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example
println!("{}", value.on_blue());
Source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example
println!("{}", value.on_magenta());
Source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example
println!("{}", value.on_cyan());
Source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example
println!("{}", value.on_white());
Source§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlack].

§Example
println!("{}", value.on_bright_black());
Source§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightRed].

§Example
println!("{}", value.on_bright_red());
Source§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightGreen].

§Example
println!("{}", value.on_bright_green());
Source§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
Source§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlue].

§Example
println!("{}", value.on_bright_blue());
Source§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
Source§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightCyan].

§Example
println!("{}", value.on_bright_cyan());
Source§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightWhite].

§Example
println!("{}", value.on_bright_white());
Source§

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 bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example
println!("{}", value.bold());
Source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example
println!("{}", value.dim());
Source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example
println!("{}", value.italic());
Source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example
println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

§Example
println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example
println!("{}", value.rapid_blink());
Source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example
println!("{}", value.invert());
Source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example
println!("{}", value.conceal());
Source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example
println!("{}", value.strike());
Source§

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 mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example
println!("{}", value.mask());
Source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example
println!("{}", value.wrap());
Source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example
println!("{}", value.linger());
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.

Returns self with the quirk() set to [Quirk :: Clear].

§Example
println!("{}", value.clear());
Source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example
println!("{}", value.resetting());
Source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example
println!("{}", value.bright());
Source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example
println!("{}", value.on_bright());
Source§

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);
Source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
Source§

impl<T> PyErrArguments for T
where T: for<'py> IntoPyObject<'py> + Send + Sync,

Source§

fn arguments(self, py: Python<'_>) -> Py<PyAny>

Arguments for exception
Source§

impl<T> PyTypeCheck for T
where T: PyTypeInfo,

Source§

const TYPE_HINT: PyStaticExpr = <T as PyTypeInfo>::TYPE_HINT

Provides the full python type of the allowed values as a Python type hint.
Source§

fn type_check(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of Self, which may include a subtype. Read more
Source§

fn classinfo_object(py: Python<'_>) -> Bound<'_, PyAny>

Returns the expected type as a possible argument for the isinstance and issubclass function. Read more
Source§

impl<T> StdoutFmt for T
where T: Display,

Source§

fn fg<C>(self, color: C) -> Foreground<Self>
where C: Into<Option<Color>>,

Give this value the specified foreground colour, when color is enabled for stdout.
Source§

fn bg<C>(self, color: C) -> Background<Self>
where C: Into<Option<Color>>,

Give this value the specified background colour, when color is enabled for stdout.
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> Ungil for T
where T: Send,