SourceVisitor

foundry_evm_coverage::analysis

Struct SourceVisitor 

Source 
struct SourceVisitor<'gcx> {
    source_id: u32,
    gcx: Gcx<'gcx>,
    contract_name: Arc<str>,
    branch_id: u32,
    items: Vec<CoverageItem>,
    all_lines: Vec<u32>,
    function_calls: Vec<Span>,
    function_calls_set: FxHashSet<Span>,
}
Expand description

A visitor that walks the AST of a single contract and finds coverage items.

Fields§

§source_id: u32

The source ID of the contract.

§gcx: Gcx<'gcx>

The solar session for span resolution.

§contract_name: Arc<str>

The name of the contract being walked.

§branch_id: u32

The current branch ID

§items: Vec<CoverageItem>

Coverage items

§all_lines: Vec<u32>§function_calls: Vec<Span>§function_calls_set: FxHashSet<Span>

Implementations§

Source§

impl<'gcx> SourceVisitor<'gcx>

Source

fn new(source_id: u32, gcx: Gcx<'gcx>) -> Self

Source

fn checkpoint(&self) -> SourceVisitorCheckpoint

Source

fn restore_checkpoint(&mut self, checkpoint: SourceVisitorCheckpoint)

Source

fn visit_contract<'ast>(&mut self, contract: &'ast ItemContract<'ast>)

Source

fn has_tests(&self, checkpoint: &SourceVisitorCheckpoint) -> bool

Returns true if the contract has any test functions.

Source

fn disambiguate_functions(&mut self)

Disambiguate functions with the same name in the same contract.

Source

fn resolve_function_calls(&mut self, hir_source_id: SourceId)

Source

fn sort(&mut self)

Source

fn push_lines(&mut self)

Source

fn push_stmt(&mut self, span: Span)

Source

fn push_item_kind(&mut self, kind: CoverageItemKind, span: Span)

Creates a coverage item for a given kind and source location. Pushes item to the internal collection (plus additional coverage line if item is a statement).

Source

fn source_location_for(&self, span: Span) -> SourceLocation

Source

fn byte_range(&self, span: Span) -> Range<u32>

Source

fn line_range(&self, span: Span) -> Range<u32>

Source

fn next_branch_id(&mut self) -> u32

Trait Implementations§

Source§

impl<'gcx> Clone for SourceVisitor<'gcx>

Source§

fn clone(&self) -> SourceVisitor<'gcx>

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<'ast> Visit<'ast> for SourceVisitor<'_>

Source§

type BreakValue = <fn() -> ! as GetReturnType>::ReturnType

The value returned when breaking from the traversal. Read more
Source§

fn visit_item_contract( &mut self, contract: &'ast ItemContract<'ast>, ) -> ControlFlow<Self::BreakValue>

Source§

fn visit_item( &mut self, item: &'ast Item<'ast>, ) -> ControlFlow<Self::BreakValue>

Source§

fn visit_stmt( &mut self, stmt: &'ast Stmt<'ast>, ) -> ControlFlow<Self::BreakValue>

Source§

fn visit_expr( &mut self, expr: &'ast Expr<'ast>, ) -> ControlFlow<Self::BreakValue>

Source§

fn visit_yul_stmt( &mut self, stmt: &'ast Stmt<'ast>, ) -> ControlFlow<Self::BreakValue>

Source§

fn visit_yul_expr( &mut self, expr: &'ast Expr<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_source_unit( &mut self, source_unit: &'ast SourceUnit<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_pragma_directive( &mut self, pragma: &'ast PragmaDirective<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_import_directive( &mut self, import: &'ast ImportDirective<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_using_directive( &mut self, using: &'ast UsingDirective<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_item_function( &mut self, function: &'ast ItemFunction<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_item_struct( &mut self, strukt: &'ast ItemStruct<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_item_enum( &mut self, enum_: &'ast ItemEnum<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_item_udvt( &mut self, udvt: &'ast ItemUdvt<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_item_error( &mut self, error: &'ast ItemError<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_item_event( &mut self, event: &'ast ItemEvent<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_variable_definition( &mut self, var: &'ast VariableDefinition<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_ty(&mut self, ty: &'ast Type<'ast>) -> ControlFlow<Self::BreakValue>

§

fn visit_function_header( &mut self, header: &'ast FunctionHeader<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_modifier( &mut self, modifier: &'ast Modifier<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_override( &mut self, override_: &'ast Override<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_call_args( &mut self, args: &'ast CallArgs<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_named_args( &mut self, args: &'ast &'ast mut [NamedArg<'ast>], ) -> ControlFlow<Self::BreakValue>

§

fn visit_stmt_assembly( &mut self, assembly: &'ast StmtAssembly<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_stmt_try( &mut self, try_: &'ast StmtTry<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_try_catch_clause( &mut self, catch: &'ast TryCatchClause<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_block( &mut self, block: &'ast Block<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_parameter_list( &mut self, list: &'ast ParameterList<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_lit(&mut self, lit: &'ast Lit<'_>) -> ControlFlow<Self::BreakValue>

§

fn visit_yul_block( &mut self, block: &'ast Block<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_yul_stmt_switch( &mut self, switch: &'ast StmtSwitch<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_yul_stmt_case( &mut self, case: &'ast StmtSwitchCase<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_yul_function( &mut self, function: &'ast Function<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_yul_expr_call( &mut self, call: &'ast ExprCall<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_doc_comments( &mut self, doc_comments: &'ast DocComments<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_doc_comment( &mut self, doc_comment: &'ast DocComment, ) -> ControlFlow<Self::BreakValue>

§

fn visit_path(&mut self, path: &'ast PathSlice) -> ControlFlow<Self::BreakValue>

§

fn visit_ident(&mut self, ident: &'ast Ident) -> ControlFlow<Self::BreakValue>

§

fn visit_span(&mut self, span: &'ast Span) -> ControlFlow<Self::BreakValue>

§

fn walk_source_unit( &mut self, source_unit: &'ast SourceUnit<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_item(&mut self, item: &'ast Item<'ast>) -> ControlFlow<Self::BreakValue>

§

fn walk_pragma_directive( &mut self, pragma: &'ast PragmaDirective<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_import_directive( &mut self, import: &'ast ImportDirective<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_using_directive( &mut self, using: &'ast UsingDirective<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_item_contract( &mut self, contract: &'ast ItemContract<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_item_function( &mut self, function: &'ast ItemFunction<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_item_struct( &mut self, strukt: &'ast ItemStruct<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_item_enum( &mut self, enum_: &'ast ItemEnum<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_item_udvt( &mut self, udvt: &'ast ItemUdvt<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_item_error( &mut self, error: &'ast ItemError<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_item_event( &mut self, event: &'ast ItemEvent<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_variable_definition( &mut self, var: &'ast VariableDefinition<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_ty(&mut self, ty: &'ast Type<'ast>) -> ControlFlow<Self::BreakValue>

§

fn walk_function_header( &mut self, header: &'ast FunctionHeader<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_modifier( &mut self, modifier: &'ast Modifier<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_override( &mut self, override_: &'ast Override<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_call_args( &mut self, args: &'ast CallArgs<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_named_args( &mut self, args: &'ast &'ast mut [NamedArg<'ast>], ) -> ControlFlow<Self::BreakValue>

§

fn walk_stmt(&mut self, stmt: &'ast Stmt<'ast>) -> ControlFlow<Self::BreakValue>

§

fn walk_stmt_assembly( &mut self, assembly: &'ast StmtAssembly<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_stmt_try( &mut self, try_: &'ast StmtTry<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_try_catch_clause( &mut self, catch: &'ast TryCatchClause<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_block( &mut self, block: &'ast Block<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_expr(&mut self, expr: &'ast Expr<'ast>) -> ControlFlow<Self::BreakValue>

§

fn walk_parameter_list( &mut self, list: &'ast ParameterList<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_lit(&mut self, lit: &'ast Lit<'_>) -> ControlFlow<Self::BreakValue>

§

fn walk_yul_stmt( &mut self, stmt: &'ast Stmt<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_yul_block( &mut self, block: &'ast Block<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_yul_stmt_switch( &mut self, switch: &'ast StmtSwitch<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_yul_stmt_case( &mut self, case: &'ast StmtSwitchCase<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_yul_function( &mut self, function: &'ast Function<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_yul_expr( &mut self, expr: &'ast Expr<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_yul_expr_call( &mut self, call: &'ast ExprCall<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_doc_comments( &mut self, doc_comments: &'ast DocComments<'ast>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_doc_comment( &mut self, doc_comment: &'ast DocComment, ) -> ControlFlow<Self::BreakValue>

§

fn walk_path(&mut self, path: &'ast PathSlice) -> ControlFlow<Self::BreakValue>

§

fn walk_ident(&mut self, ident: &'ast Ident) -> ControlFlow<Self::BreakValue>

§

fn walk_span(&mut self, span: &'ast Span) -> ControlFlow<Self::BreakValue>

Source§

impl<'gcx> Visit<'gcx> for SourceVisitor<'gcx>

Source§

type BreakValue = <fn() -> ! as GetReturnType>::ReturnType

The value returned when breaking from the traversal. Read more
Source§

fn hir(&self) -> &'gcx Hir<'gcx>

Returns the HIR map.
Source§

fn visit_expr( &mut self, expr: &'gcx Expr<'gcx>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_nested_source(&mut self, id: SourceId) -> ControlFlow<Self::BreakValue>

§

fn visit_nested_item(&mut self, id: ItemId) -> ControlFlow<Self::BreakValue>

§

fn visit_item( &mut self, item: Item<'hir, 'hir>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_nested_contract( &mut self, id: ContractId, ) -> ControlFlow<Self::BreakValue>

§

fn visit_contract( &mut self, contract: &'hir Contract<'hir>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_nested_function( &mut self, id: FunctionId, ) -> ControlFlow<Self::BreakValue>

§

fn visit_function( &mut self, func: &'hir Function<'hir>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_modifier( &mut self, modifier: &'hir Modifier<'hir>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_nested_var(&mut self, id: VariableId) -> ControlFlow<Self::BreakValue>

§

fn visit_var( &mut self, var: &'hir Variable<'hir>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_call_args( &mut self, args: &'hir CallArgs<'hir>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_stmt( &mut self, stmt: &'hir Stmt<'hir>, ) -> ControlFlow<Self::BreakValue>

§

fn visit_ty(&mut self, ty: &'hir Type<'hir>) -> ControlFlow<Self::BreakValue>

§

fn walk_nested_source(&mut self, id: SourceId) -> ControlFlow<Self::BreakValue>

§

fn walk_nested_item(&mut self, id: ItemId) -> ControlFlow<Self::BreakValue>

§

fn walk_item(&mut self, item: Item<'hir, 'hir>) -> ControlFlow<Self::BreakValue>

§

fn walk_nested_contract( &mut self, id: ContractId, ) -> ControlFlow<Self::BreakValue>

§

fn walk_contract( &mut self, contract: &'hir Contract<'hir>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_nested_function( &mut self, id: FunctionId, ) -> ControlFlow<Self::BreakValue>

§

fn walk_function( &mut self, func: &'hir Function<'hir>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_modifier( &mut self, modifier: &'hir Modifier<'hir>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_nested_var(&mut self, id: VariableId) -> ControlFlow<Self::BreakValue>

§

fn walk_var( &mut self, var: &'hir Variable<'hir>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_expr(&mut self, expr: &'hir Expr<'hir>) -> ControlFlow<Self::BreakValue>

§

fn walk_call_args( &mut self, args: &'hir CallArgs<'hir>, ) -> ControlFlow<Self::BreakValue>

§

fn walk_stmt(&mut self, stmt: &'hir Stmt<'hir>) -> ControlFlow<Self::BreakValue>

§

fn walk_ty(&mut self, ty: &'hir Type<'hir>) -> ControlFlow<Self::BreakValue>

Auto Trait Implementations§

§

impl<'gcx> Freeze for SourceVisitor<'gcx>

§

impl<'gcx> !RefUnwindSafe for SourceVisitor<'gcx>

§

impl<'gcx> Send for SourceVisitor<'gcx>

§

impl<'gcx> Sync for SourceVisitor<'gcx>

§

impl<'gcx> Unpin for SourceVisitor<'gcx>

§

impl<'gcx> !UnwindSafe for SourceVisitor<'gcx>

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
§

impl<T, R> CollectAndApply<T, R> for T

§

fn collect_and_apply<I, F>(iter: I, f: F) -> R
where I: Iterator<Item = T>, F: FnOnce(&[T]) -> R,

Equivalent to f(&iter.collect::<Vec<_>>()).

§

type Output = R

§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<TxEnv, T> FromRecoveredTx<&T> for TxEnv
where TxEnv: FromRecoveredTx<T>,

§

fn from_recovered_tx(tx: &&T, sender: Address) -> TxEnv

Builds a [TxEnv] from a transaction and a sender address.
§

impl<TxEnv, T> FromTxWithEncoded<&T> for TxEnv
where TxEnv: FromTxWithEncoded<T>,

§

fn from_encoded_tx(tx: &&T, sender: Address, encoded: Bytes) -> TxEnv

Builds a [TxEnv] from a transaction, its sender, and encoded transaction bytes.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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
§

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

§

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

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

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

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> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
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
§

impl<T> TryClone for T
where T: Clone,

§

fn try_clone(&self) -> Result<T, Error>

Clones self, possibly returning an error.
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. 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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

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
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T

Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 136 bytes