Skip to main content

ExprKind

Enum ExprKind 

Source
pub enum ExprKind {
Show 18 variants Ident(Path), Lookup { base: Box<Expr>, lookup: Lookup, }, Literal(Literal), Nested(Box<Expr>), TypeAnnotation(TypeAnnotation), Tuple(Vec<TupleField>), Array(Vec<Expr>), Variant(Variant), Range(Range), Binary(BinaryExpr), Unary(UnaryExpr), Call(Call), Func(Box<Func>), FuncShort(Box<FuncShort>), FString(Vec<InterpolateItem>), Match(Match), If(If), VarBinding(VarBinding),
}

Variants§

§

Ident(Path)

§

Lookup

A lookup into an object by name or position. Currently, this includes only tuple field lookups, primarily by name.

Fields

§base: Box<Expr>
§lookup: Lookup
§

Literal(Literal)

§

Nested(Box<Expr>)

§

TypeAnnotation(TypeAnnotation)

§

Tuple(Vec<TupleField>)

§

Array(Vec<Expr>)

§

Variant(Variant)

§

Range(Range)

§

Binary(BinaryExpr)

§

Unary(UnaryExpr)

§

Call(Call)

§

Func(Box<Func>)

§

FuncShort(Box<FuncShort>)

§

FString(Vec<InterpolateItem>)

§

Match(Match)

§

If(If)

§

VarBinding(VarBinding)

Implementations§

Source§

impl ExprKind

Source

pub fn is_ident(&self) -> bool

Returns true if this is a ExprKind::Ident, otherwise false

Source

pub fn as_ident_mut(&mut self) -> Option<&mut Path>

Optionally returns mutable references to the inner fields if this is a ExprKind::Ident, otherwise None

Source

pub fn as_ident(&self) -> Option<&Path>

Optionally returns references to the inner fields if this is a ExprKind::Ident, otherwise None

Source

pub fn into_ident(self) -> Result<Path, Self>

Returns the inner fields if this is a ExprKind::Ident, otherwise returns back the enum in the Err case of the result

Source

pub fn is_lookup(&self) -> bool

Returns true if this is a ExprKind::Lookup, otherwise false

Source

pub fn as_lookup_mut(&mut self) -> Option<(&mut Box<Expr>, &mut Lookup)>

Optionally returns mutable references to the inner fields if this is a ExprKind::Lookup, otherwise None

Source

pub fn as_lookup(&self) -> Option<(&Box<Expr>, &Lookup)>

Optionally returns references to the inner fields if this is a ExprKind::Lookup, otherwise None

Source

pub fn into_lookup(self) -> Result<(Box<Expr>, Lookup), Self>

Returns the inner fields if this is a ExprKind::Lookup, otherwise returns back the enum in the Err case of the result

Source

pub fn is_literal(&self) -> bool

Returns true if this is a ExprKind::Literal, otherwise false

Source

pub fn as_literal_mut(&mut self) -> Option<&mut Literal>

Optionally returns mutable references to the inner fields if this is a ExprKind::Literal, otherwise None

Source

pub fn as_literal(&self) -> Option<&Literal>

Optionally returns references to the inner fields if this is a ExprKind::Literal, otherwise None

Source

pub fn into_literal(self) -> Result<Literal, Self>

Returns the inner fields if this is a ExprKind::Literal, otherwise returns back the enum in the Err case of the result

Source

pub fn is_nested(&self) -> bool

Returns true if this is a ExprKind::Nested, otherwise false

Source

pub fn as_nested_mut(&mut self) -> Option<&mut Box<Expr>>

Optionally returns mutable references to the inner fields if this is a ExprKind::Nested, otherwise None

Source

pub fn as_nested(&self) -> Option<&Box<Expr>>

Optionally returns references to the inner fields if this is a ExprKind::Nested, otherwise None

Source

pub fn into_nested(self) -> Result<Box<Expr>, Self>

Returns the inner fields if this is a ExprKind::Nested, otherwise returns back the enum in the Err case of the result

Source

pub fn is_type_annotation(&self) -> bool

Returns true if this is a ExprKind::TypeAnnotation, otherwise false

Source

pub fn as_type_annotation_mut(&mut self) -> Option<&mut TypeAnnotation>

Optionally returns mutable references to the inner fields if this is a ExprKind::TypeAnnotation, otherwise None

Source

pub fn as_type_annotation(&self) -> Option<&TypeAnnotation>

Optionally returns references to the inner fields if this is a ExprKind::TypeAnnotation, otherwise None

Source

pub fn into_type_annotation(self) -> Result<TypeAnnotation, Self>

Returns the inner fields if this is a ExprKind::TypeAnnotation, otherwise returns back the enum in the Err case of the result

Source

pub fn is_tuple(&self) -> bool

Returns true if this is a ExprKind::Tuple, otherwise false

Source

pub fn as_tuple_mut(&mut self) -> Option<&mut Vec<TupleField>>

Optionally returns mutable references to the inner fields if this is a ExprKind::Tuple, otherwise None

Source

pub fn as_tuple(&self) -> Option<&Vec<TupleField>>

Optionally returns references to the inner fields if this is a ExprKind::Tuple, otherwise None

Source

pub fn into_tuple(self) -> Result<Vec<TupleField>, Self>

Returns the inner fields if this is a ExprKind::Tuple, otherwise returns back the enum in the Err case of the result

Source

pub fn is_array(&self) -> bool

Returns true if this is a ExprKind::Array, otherwise false

Source

pub fn as_array_mut(&mut self) -> Option<&mut Vec<Expr>>

Optionally returns mutable references to the inner fields if this is a ExprKind::Array, otherwise None

Source

pub fn as_array(&self) -> Option<&Vec<Expr>>

Optionally returns references to the inner fields if this is a ExprKind::Array, otherwise None

Source

pub fn into_array(self) -> Result<Vec<Expr>, Self>

Returns the inner fields if this is a ExprKind::Array, otherwise returns back the enum in the Err case of the result

Source

pub fn is_variant(&self) -> bool

Returns true if this is a ExprKind::Variant, otherwise false

Source

pub fn as_variant_mut(&mut self) -> Option<&mut Variant>

Optionally returns mutable references to the inner fields if this is a ExprKind::Variant, otherwise None

Source

pub fn as_variant(&self) -> Option<&Variant>

Optionally returns references to the inner fields if this is a ExprKind::Variant, otherwise None

Source

pub fn into_variant(self) -> Result<Variant, Self>

Returns the inner fields if this is a ExprKind::Variant, otherwise returns back the enum in the Err case of the result

Source

pub fn is_range(&self) -> bool

Returns true if this is a ExprKind::Range, otherwise false

Source

pub fn as_range_mut(&mut self) -> Option<&mut Range>

Optionally returns mutable references to the inner fields if this is a ExprKind::Range, otherwise None

Source

pub fn as_range(&self) -> Option<&Range>

Optionally returns references to the inner fields if this is a ExprKind::Range, otherwise None

Source

pub fn into_range(self) -> Result<Range, Self>

Returns the inner fields if this is a ExprKind::Range, otherwise returns back the enum in the Err case of the result

Source

pub fn is_binary(&self) -> bool

Returns true if this is a ExprKind::Binary, otherwise false

Source

pub fn as_binary_mut(&mut self) -> Option<&mut BinaryExpr>

Optionally returns mutable references to the inner fields if this is a ExprKind::Binary, otherwise None

Source

pub fn as_binary(&self) -> Option<&BinaryExpr>

Optionally returns references to the inner fields if this is a ExprKind::Binary, otherwise None

Source

pub fn into_binary(self) -> Result<BinaryExpr, Self>

Returns the inner fields if this is a ExprKind::Binary, otherwise returns back the enum in the Err case of the result

Source

pub fn is_unary(&self) -> bool

Returns true if this is a ExprKind::Unary, otherwise false

Source

pub fn as_unary_mut(&mut self) -> Option<&mut UnaryExpr>

Optionally returns mutable references to the inner fields if this is a ExprKind::Unary, otherwise None

Source

pub fn as_unary(&self) -> Option<&UnaryExpr>

Optionally returns references to the inner fields if this is a ExprKind::Unary, otherwise None

Source

pub fn into_unary(self) -> Result<UnaryExpr, Self>

Returns the inner fields if this is a ExprKind::Unary, otherwise returns back the enum in the Err case of the result

Source

pub fn is_call(&self) -> bool

Returns true if this is a ExprKind::Call, otherwise false

Source

pub fn as_call_mut(&mut self) -> Option<&mut Call>

Optionally returns mutable references to the inner fields if this is a ExprKind::Call, otherwise None

Source

pub fn as_call(&self) -> Option<&Call>

Optionally returns references to the inner fields if this is a ExprKind::Call, otherwise None

Source

pub fn into_call(self) -> Result<Call, Self>

Returns the inner fields if this is a ExprKind::Call, otherwise returns back the enum in the Err case of the result

Source

pub fn is_func(&self) -> bool

Returns true if this is a ExprKind::Func, otherwise false

Source

pub fn as_func_mut(&mut self) -> Option<&mut Box<Func>>

Optionally returns mutable references to the inner fields if this is a ExprKind::Func, otherwise None

Source

pub fn as_func(&self) -> Option<&Box<Func>>

Optionally returns references to the inner fields if this is a ExprKind::Func, otherwise None

Source

pub fn into_func(self) -> Result<Box<Func>, Self>

Returns the inner fields if this is a ExprKind::Func, otherwise returns back the enum in the Err case of the result

Source

pub fn is_func_short(&self) -> bool

Returns true if this is a ExprKind::FuncShort, otherwise false

Source

pub fn as_func_short_mut(&mut self) -> Option<&mut Box<FuncShort>>

Optionally returns mutable references to the inner fields if this is a ExprKind::FuncShort, otherwise None

Source

pub fn as_func_short(&self) -> Option<&Box<FuncShort>>

Optionally returns references to the inner fields if this is a ExprKind::FuncShort, otherwise None

Source

pub fn into_func_short(self) -> Result<Box<FuncShort>, Self>

Returns the inner fields if this is a ExprKind::FuncShort, otherwise returns back the enum in the Err case of the result

Source

pub fn is_f_string(&self) -> bool

Returns true if this is a ExprKind::FString, otherwise false

Source

pub fn as_f_string_mut(&mut self) -> Option<&mut Vec<InterpolateItem>>

Optionally returns mutable references to the inner fields if this is a ExprKind::FString, otherwise None

Source

pub fn as_f_string(&self) -> Option<&Vec<InterpolateItem>>

Optionally returns references to the inner fields if this is a ExprKind::FString, otherwise None

Source

pub fn into_f_string(self) -> Result<Vec<InterpolateItem>, Self>

Returns the inner fields if this is a ExprKind::FString, otherwise returns back the enum in the Err case of the result

Source

pub fn is_match(&self) -> bool

Returns true if this is a ExprKind::Match, otherwise false

Source

pub fn as_match_mut(&mut self) -> Option<&mut Match>

Optionally returns mutable references to the inner fields if this is a ExprKind::Match, otherwise None

Source

pub fn as_match(&self) -> Option<&Match>

Optionally returns references to the inner fields if this is a ExprKind::Match, otherwise None

Source

pub fn into_match(self) -> Result<Match, Self>

Returns the inner fields if this is a ExprKind::Match, otherwise returns back the enum in the Err case of the result

Source

pub fn is_if(&self) -> bool

Returns true if this is a ExprKind::If, otherwise false

Source

pub fn as_if_mut(&mut self) -> Option<&mut If>

Optionally returns mutable references to the inner fields if this is a ExprKind::If, otherwise None

Source

pub fn as_if(&self) -> Option<&If>

Optionally returns references to the inner fields if this is a ExprKind::If, otherwise None

Source

pub fn into_if(self) -> Result<If, Self>

Returns the inner fields if this is a ExprKind::If, otherwise returns back the enum in the Err case of the result

Source

pub fn is_var_binding(&self) -> bool

Returns true if this is a ExprKind::VarBinding, otherwise false

Source

pub fn as_var_binding_mut(&mut self) -> Option<&mut VarBinding>

Optionally returns mutable references to the inner fields if this is a ExprKind::VarBinding, otherwise None

Source

pub fn as_var_binding(&self) -> Option<&VarBinding>

Optionally returns references to the inner fields if this is a ExprKind::VarBinding, otherwise None

Source

pub fn into_var_binding(self) -> Result<VarBinding, Self>

Returns the inner fields if this is a ExprKind::VarBinding, otherwise returns back the enum in the Err case of the result

Trait Implementations§

Source§

impl AsRef<str> for ExprKind

Source§

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl Clone for ExprKind

Source§

fn clone(&self) -> ExprKind

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 ExprKind

Source§

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

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

impl From<Func> for ExprKind

Source§

fn from(value: Func) -> Self

Converts to this type from the input type.
Source§

impl From<Literal> for ExprKind

Source§

fn from(value: Literal) -> Self

Converts to this type from the input type.
Source§

impl From<Path> for ExprKind

Source§

fn from(value: Path) -> Self

Converts to this type from the input type.
Source§

impl From<Range> for ExprKind

Source§

fn from(value: Range) -> Self

Converts to this type from the input type.
Source§

impl From<TypeAnnotation> for ExprKind

Source§

fn from(value: TypeAnnotation) -> Self

Converts to this type from the input type.
Source§

impl From<Variant> for ExprKind

Source§

fn from(value: Variant) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for ExprKind

Source§

fn eq(&self, other: &ExprKind) -> 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 ExprKind

Auto Trait Implementations§

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> Chain<T> for T

Source§

fn len(&self) -> usize

The number of items that this chain link consists of.
Source§

fn append_to(self, v: &mut Vec<T>)

Append the elements in this link to the chain.
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> Container<T> for T
where T: Clone,

Source§

type Iter = Once<T>

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

fn get_iter(&self) -> <T as Container<T>>::Iter

Iterate over the elements of the container (using internal iteration because GATs are unstable).
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<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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