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();

§

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

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

§Example

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

§

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

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

§Example

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

§

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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();

§

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

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

§Example

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

§

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

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

§Example

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

§

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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();

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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();

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

println!("{}", value.linger());

§

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());

§

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

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

§Example

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

§

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

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

§Example

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

§

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

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

§Example

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

§

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

§

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

Create a new [Painted] with a default [Style]. Read more

§

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

§

impl<T, P> Parse<Box<T>> for P
where P: Parse<T>,

§

fn parse(&mut self) -> Result<Box<T>, Error>

§

Performs the conversion.

Source §

impl<T, U> TryInto for T
where U: TryFrom<T>,

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

§

impl<T> WithSubscriber for T

§

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

§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

§

TplConverter

Struct TplConverter Copy item path

Trait Implementations§

impl Debug for TplConverter

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

impl Fold for TplConverter

fn fold_accessibility(&mut self, node: Accessibility) -> Accessibility

fn fold_true_plus_minus(&mut self, node: TruePlusMinus) -> TruePlusMinus

fn fold_ts_array_type(&mut self, node: TsArrayType) -> TsArrayType

fn fold_ts_call_signature_decl( &mut self, node: TsCallSignatureDecl, ) -> TsCallSignatureDecl

fn fold_ts_conditional_type( &mut self, node: TsConditionalType, ) -> TsConditionalType

fn fold_ts_construct_signature_decl( &mut self, node: TsConstructSignatureDecl, ) -> TsConstructSignatureDecl

fn fold_ts_constructor_type( &mut self, node: TsConstructorType, ) -> TsConstructorType

fn fold_ts_entity_name(&mut self, node: TsEntityName) -> TsEntityName

fn fold_ts_enum_decl(&mut self, node: TsEnumDecl) -> TsEnumDecl

fn fold_ts_enum_member(&mut self, node: TsEnumMember) -> TsEnumMember

fn fold_ts_enum_member_id(&mut self, node: TsEnumMemberId) -> TsEnumMemberId

fn fold_ts_expr_with_type_args( &mut self, node: TsExprWithTypeArgs, ) -> TsExprWithTypeArgs

fn fold_ts_fn_or_constructor_type( &mut self, node: TsFnOrConstructorType, ) -> TsFnOrConstructorType

fn fold_ts_fn_param(&mut self, node: TsFnParam) -> TsFnParam

fn fold_ts_fn_type(&mut self, node: TsFnType) -> TsFnType

fn fold_ts_import_equals_decl( &mut self, node: TsImportEqualsDecl, ) -> TsImportEqualsDecl

fn fold_ts_import_type(&mut self, node: TsImportType) -> TsImportType

fn fold_ts_index_signature( &mut self, node: TsIndexSignature, ) -> TsIndexSignature

fn fold_ts_indexed_access_type( &mut self, node: TsIndexedAccessType, ) -> TsIndexedAccessType

fn fold_ts_infer_type(&mut self, node: TsInferType) -> TsInferType

fn fold_ts_interface_body(&mut self, node: TsInterfaceBody) -> TsInterfaceBody

fn fold_ts_interface_decl(&mut self, node: TsInterfaceDecl) -> TsInterfaceDecl

fn fold_ts_intersection_type( &mut self, node: TsIntersectionType, ) -> TsIntersectionType

fn fold_ts_keyword_type(&mut self, node: TsKeywordType) -> TsKeywordType

fn fold_ts_keyword_type_kind( &mut self, node: TsKeywordTypeKind, ) -> TsKeywordTypeKind

fn fold_ts_mapped_type(&mut self, node: TsMappedType) -> TsMappedType

fn fold_ts_method_signature( &mut self, node: TsMethodSignature, ) -> TsMethodSignature

fn fold_ts_module_block(&mut self, node: TsModuleBlock) -> TsModuleBlock

fn fold_ts_module_decl(&mut self, node: TsModuleDecl) -> TsModuleDecl

fn fold_ts_module_name(&mut self, node: TsModuleName) -> TsModuleName

fn fold_ts_namespace_body(&mut self, node: TsNamespaceBody) -> TsNamespaceBody

fn fold_ts_namespace_decl(&mut self, node: TsNamespaceDecl) -> TsNamespaceDecl

fn fold_ts_namespace_export_decl( &mut self, node: TsNamespaceExportDecl, ) -> TsNamespaceExportDecl

fn fold_ts_optional_type(&mut self, node: TsOptionalType) -> TsOptionalType

fn fold_ts_param_prop(&mut self, node: TsParamProp) -> TsParamProp

fn fold_ts_param_prop_param( &mut self, node: TsParamPropParam, ) -> TsParamPropParam

fn fold_ts_parenthesized_type( &mut self, node: TsParenthesizedType, ) -> TsParenthesizedType

fn fold_ts_property_signature( &mut self, node: TsPropertySignature, ) -> TsPropertySignature

fn fold_ts_qualified_name(&mut self, node: TsQualifiedName) -> TsQualifiedName

fn fold_ts_rest_type(&mut self, node: TsRestType) -> TsRestType

fn fold_ts_this_type(&mut self, node: TsThisType) -> TsThisType

fn fold_ts_this_type_or_ident( &mut self, node: TsThisTypeOrIdent, ) -> TsThisTypeOrIdent

fn fold_ts_tuple_type(&mut self, node: TsTupleType) -> TsTupleType

fn fold_ts_type(&mut self, node: TsType) -> TsType

fn fold_ts_type_alias_decl(&mut self, node: TsTypeAliasDecl) -> TsTypeAliasDecl

fn fold_ts_type_ann(&mut self, node: TsTypeAnn) -> TsTypeAnn

fn fold_ts_type_assertion(&mut self, node: TsTypeAssertion) -> TsTypeAssertion

fn fold_ts_type_element(&mut self, node: TsTypeElement) -> TsTypeElement

fn fold_ts_type_lit(&mut self, node: TsTypeLit) -> TsTypeLit

fn fold_ts_type_operator(&mut self, node: TsTypeOperator) -> TsTypeOperator

fn fold_ts_type_operator_op( &mut self, node: TsTypeOperatorOp, ) -> TsTypeOperatorOp

fn fold_ts_type_param(&mut self, node: TsTypeParam) -> TsTypeParam

fn fold_ts_type_param_decl(&mut self, node: TsTypeParamDecl) -> TsTypeParamDecl

fn fold_ts_type_param_instantiation( &mut self, node: TsTypeParamInstantiation, ) -> TsTypeParamInstantiation

fn fold_ts_type_predicate(&mut self, node: TsTypePredicate) -> TsTypePredicate

fn fold_ts_type_query(&mut self, node: TsTypeQuery) -> TsTypeQuery

fn fold_ts_type_query_expr(&mut self, node: TsTypeQueryExpr) -> TsTypeQueryExpr

fn fold_ts_type_ref(&mut self, node: TsTypeRef) -> TsTypeRef

fn fold_ts_union_or_intersection_type( &mut self, node: TsUnionOrIntersectionType, ) -> TsUnionOrIntersectionType

fn fold_ts_union_type(&mut self, node: TsUnionType) -> TsUnionType

fn fold_expr(&mut self, expr: Expr) -> Expr

fn fold_array_lit(&mut self, node: ArrayLit) -> ArrayLit

fn fold_array_pat(&mut self, node: ArrayPat) -> ArrayPat

fn fold_arrow_expr(&mut self, node: ArrowExpr) -> ArrowExpr

fn fold_assign_expr(&mut self, node: AssignExpr) -> AssignExpr

fn fold_assign_op(&mut self, node: AssignOp) -> AssignOp

fn fold_assign_pat(&mut self, node: AssignPat) -> AssignPat

fn fold_assign_pat_prop(&mut self, node: AssignPatProp) -> AssignPatProp

fn fold_assign_prop(&mut self, node: AssignProp) -> AssignProp

fn fold_assign_target(&mut self, node: AssignTarget) -> AssignTarget

fn fold_assign_target_pat(&mut self, node: AssignTargetPat) -> AssignTargetPat

fn fold_atom(&mut self, node: Atom) -> Atom

fn fold_auto_accessor(&mut self, node: AutoAccessor) -> AutoAccessor

fn fold_await_expr(&mut self, node: AwaitExpr) -> AwaitExpr

Struct TplConverter