Enum ExecutionError

Source
pub enum ExecutionError {
Show 41 variants AdviceMapKeyNotFound { label: SourceSpan, source_file: Option<Arc<SourceFile>>, key: [BaseElement; 4], }, AdviceMapKeyAlreadyPresent { key: [BaseElement; 4], prev_values: Vec<BaseElement>, new_values: Vec<BaseElement>, }, AdviceStackReadFailed { label: SourceSpan, source_file: Option<Arc<SourceFile>>, row: RowIndex, }, CallInSyscall(&'static str), CallerNotInSyscall, CircularExternalNode(RpoDigest), CycleLimitExceeded(u32), DecoratorNotFoundInForest { decorator_id: DecoratorId, }, DivideByZero { label: SourceSpan, source_file: Option<Arc<SourceFile>>, clk: RowIndex, }, DynamicNodeNotFound { label: SourceSpan, source_file: Option<Arc<SourceFile>>, digest: RpoDigest, }, EventError { label: SourceSpan, source_file: Option<Arc<SourceFile>>, error: Box<dyn Error + Sync + Send>, }, Ext2InttError(Ext2InttError), FailedAssertion { label: SourceSpan, source_file: Option<Arc<SourceFile>>, clk: RowIndex, err_code: BaseElement, err_msg: Option<Arc<str>>, }, FailedToExecuteProgram(&'static str), InvalidFmpValue(BaseElement, BaseElement), InvalidFriDomainSegment(u64), InvalidFriLayerFolding(QuadExtension<BaseElement>, QuadExtension<BaseElement>), InvalidStackDepthOnReturn { label: SourceSpan, source_file: Option<Arc<SourceFile>>, depth: usize, }, InvalidMerkleTreeDepth { label: SourceSpan, source_file: Option<Arc<SourceFile>>, depth: BaseElement, }, InvalidMerkleTreeNodeIndex { label: SourceSpan, source_file: Option<Arc<SourceFile>>, depth: BaseElement, index: BaseElement, }, LogArgumentZero { label: SourceSpan, source_file: Option<Arc<SourceFile>>, clk: RowIndex, }, MalformedSignatureKey { label: SourceSpan, source_file: Option<Arc<SourceFile>>, key_type: &'static str, }, MalformedMastForestInHost { label: SourceSpan, source_file: Option<Arc<SourceFile>>, root_digest: RpoDigest, }, MastNodeNotFoundInForest { node_id: MastNodeId, }, MemoryError(MemoryError), NoMastForestWithProcedure { label: SourceSpan, source_file: Option<Arc<SourceFile>>, root_digest: RpoDigest, }, MerklePathVerificationFailed { label: SourceSpan, source_file: Option<Arc<SourceFile>>, value: [BaseElement; 4], index: BaseElement, root: RpoDigest, err_code: BaseElement, err_msg: Option<Arc<str>>, }, MerkleStoreLookupFailed { label: SourceSpan, source_file: Option<Arc<SourceFile>>, err: MerkleError, }, MerkleStoreMergeFailed { label: SourceSpan, source_file: Option<Arc<SourceFile>>, err: MerkleError, }, MerkleStoreUpdateFailed { label: SourceSpan, source_file: Option<Arc<SourceFile>>, err: MerkleError, }, NotBinaryValueIf { label: SourceSpan, source_file: Option<Arc<SourceFile>>, value: BaseElement, }, NotBinaryValueOp { label: SourceSpan, source_file: Option<Arc<SourceFile>>, value: BaseElement, }, NotBinaryValueLoop { label: SourceSpan, source_file: Option<Arc<SourceFile>>, value: BaseElement, }, NotU32Value { label: SourceSpan, source_file: Option<Arc<SourceFile>>, value: BaseElement, err_code: BaseElement, }, OutputStackOverflow(usize), ProgramAlreadyExecuted, ProverError(ProverError), SmtNodeNotFound { label: SourceSpan, source_file: Option<Arc<SourceFile>>, node: [BaseElement; 4], }, SmtNodePreImageNotValid { label: SourceSpan, source_file: Option<Arc<SourceFile>>, node: [BaseElement; 4], preimage_len: usize, }, SyscallTargetNotInKernel { label: SourceSpan, source_file: Option<Arc<SourceFile>>, proc_root: RpoDigest, }, AceChipError { label: SourceSpan, source_file: Option<Arc<SourceFile>>, error: AceError, },
}

Variants§

§

AdviceMapKeyNotFound

Fields

§source_file: Option<Arc<SourceFile>>
§

AdviceMapKeyAlreadyPresent

Fields

§prev_values: Vec<BaseElement>
§new_values: Vec<BaseElement>
§

AdviceStackReadFailed

Fields

§source_file: Option<Arc<SourceFile>>
§

CallInSyscall(&'static str)

This error is caught by the assembler, so we don’t need diagnostics here.

§

CallerNotInSyscall

This error is caught by the assembler, so we don’t need diagnostics here.

§

CircularExternalNode(RpoDigest)

§

CycleLimitExceeded(u32)

§

DecoratorNotFoundInForest

Fields

§decorator_id: DecoratorId
§

DivideByZero

Fields

§source_file: Option<Arc<SourceFile>>
§

DynamicNodeNotFound

Fields

§source_file: Option<Arc<SourceFile>>
§digest: RpoDigest
§

EventError

Fields

§source_file: Option<Arc<SourceFile>>
§error: Box<dyn Error + Sync + Send>
§

Ext2InttError(Ext2InttError)

§

FailedAssertion

Fields

§source_file: Option<Arc<SourceFile>>
§err_code: BaseElement
§err_msg: Option<Arc<str>>
§

FailedToExecuteProgram(&'static str)

§

InvalidFmpValue(BaseElement, BaseElement)

§

InvalidFriDomainSegment(u64)

§

InvalidFriLayerFolding(QuadExtension<BaseElement>, QuadExtension<BaseElement>)

§

InvalidStackDepthOnReturn

Fields

§source_file: Option<Arc<SourceFile>>
§depth: usize
§

InvalidMerkleTreeDepth

Fields

§source_file: Option<Arc<SourceFile>>
§

InvalidMerkleTreeNodeIndex

Fields

§source_file: Option<Arc<SourceFile>>
§

LogArgumentZero

Fields

§source_file: Option<Arc<SourceFile>>
§

MalformedSignatureKey

Fields

§source_file: Option<Arc<SourceFile>>
§key_type: &'static str
§

MalformedMastForestInHost

Fields

§source_file: Option<Arc<SourceFile>>
§root_digest: RpoDigest
§

MastNodeNotFoundInForest

Fields

§node_id: MastNodeId
§

MemoryError(MemoryError)

§

NoMastForestWithProcedure

Fields

§source_file: Option<Arc<SourceFile>>
§root_digest: RpoDigest
§

MerklePathVerificationFailed

Fields

§source_file: Option<Arc<SourceFile>>
§value: [BaseElement; 4]
§err_code: BaseElement
§err_msg: Option<Arc<str>>
§

MerkleStoreLookupFailed

Fields

§source_file: Option<Arc<SourceFile>>
§

MerkleStoreMergeFailed

Fields

§source_file: Option<Arc<SourceFile>>
§

MerkleStoreUpdateFailed

Fields

§source_file: Option<Arc<SourceFile>>
§

NotBinaryValueIf

Fields

§source_file: Option<Arc<SourceFile>>
§

NotBinaryValueOp

Fields

§source_file: Option<Arc<SourceFile>>
§

NotBinaryValueLoop

Fields

§source_file: Option<Arc<SourceFile>>
§

NotU32Value

Fields

§source_file: Option<Arc<SourceFile>>
§err_code: BaseElement
§

OutputStackOverflow(usize)

§

ProgramAlreadyExecuted

§

ProverError(ProverError)

§

SmtNodeNotFound

Fields

§source_file: Option<Arc<SourceFile>>
§node: [BaseElement; 4]
§

SmtNodePreImageNotValid

Fields

§source_file: Option<Arc<SourceFile>>
§node: [BaseElement; 4]
§preimage_len: usize
§

SyscallTargetNotInKernel

Fields

§source_file: Option<Arc<SourceFile>>
§proc_root: RpoDigest
§

AceChipError

Fields

§source_file: Option<Arc<SourceFile>>
§error: AceError

Implementations§

Source§

impl ExecutionError

Source

pub fn advice_map_key_not_found( key: [BaseElement; 4], err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> ExecutionError

Source

pub fn advice_stack_read_failed( row: RowIndex, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> ExecutionError

Source

pub fn divide_by_zero( clk: RowIndex, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> ExecutionError

Source

pub fn dynamic_node_not_found( digest: RpoDigest, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> ExecutionError

Source

pub fn event_error( error: Box<dyn Error + Sync + Send>, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> ExecutionError

Source

pub fn failed_assertion( clk: RowIndex, err_code: BaseElement, err_msg: Option<Arc<str>>, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> ExecutionError

Source

pub fn invalid_merkle_tree_depth( depth: BaseElement, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> ExecutionError

Source

pub fn invalid_merkle_tree_node_index( depth: BaseElement, index: BaseElement, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> ExecutionError

Source

pub fn invalid_stack_depth_on_return( depth: usize, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> ExecutionError

Source

pub fn log_argument_zero( clk: RowIndex, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> ExecutionError

Source

pub fn malfored_mast_forest_in_host( root_digest: RpoDigest, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> ExecutionError

Source

pub fn malformed_signature_key( key_type: &'static str, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> ExecutionError

Source

pub fn merkle_path_verification_failed( value: [BaseElement; 4], index: BaseElement, root: RpoDigest, err_code: BaseElement, err_msg: Option<Arc<str>>, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> ExecutionError

Source

pub fn merkle_store_lookup_failed( err: MerkleError, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> ExecutionError

Source

pub fn merkle_store_merge_failed( err: MerkleError, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> ExecutionError

Note: This error currently never occurs, since MerkleStore::merge_roots() never fails.

Source

pub fn merkle_store_update_failed( err: MerkleError, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> ExecutionError

Source

pub fn no_mast_forest_with_procedure( root_digest: RpoDigest, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> ExecutionError

Source

pub fn not_binary_value_if( value: BaseElement, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> ExecutionError

Source

pub fn not_binary_value_op( value: BaseElement, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> ExecutionError

Source

pub fn not_binary_value_loop( value: BaseElement, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> ExecutionError

Source

pub fn not_u32_value( value: BaseElement, err_code: BaseElement, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> ExecutionError

Source

pub fn smt_node_not_found( node: [BaseElement; 4], err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> ExecutionError

Source

pub fn smt_node_preimage_not_valid( node: [BaseElement; 4], preimage_len: usize, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> ExecutionError

Source

pub fn syscall_target_not_in_kernel( proc_root: RpoDigest, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> ExecutionError

Source

pub fn failed_arithmetic_evaluation( err_ctx: &ErrorContext<'_, impl MastNodeExt>, error: AceError, ) -> ExecutionError

Trait Implementations§

Source§

impl AsRef<dyn Diagnostic> for ExecutionError

Source§

fn as_ref(&self) -> &(dyn Diagnostic + 'static)

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

impl Debug for ExecutionError

Source§

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

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

impl Diagnostic for ExecutionError

Source§

fn code(&self) -> Option<Box<dyn Display + '_>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or enums will work just fine.
Source§

fn help(&self) -> Option<Box<dyn Display + '_>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?
Source§

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic. Read more
Source§

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code
Source§

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.
Source§

fn related(&self) -> Option<Box<dyn Iterator<Item = &dyn Diagnostic> + '_>>

Additional related Diagnostics.
Source§

fn url(&self) -> Option<Box<dyn Display + '_>>

URL to visit for a more detailed explanation/help about this Diagnostic.
Source§

fn diagnostic_source(&self) -> Option<&dyn Diagnostic>

The cause of the error.
Source§

impl Display for ExecutionError

Source§

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

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

impl Error for ExecutionError

Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl From<Ext2InttError> for ExecutionError

Source§

fn from(value: Ext2InttError) -> ExecutionError

Converts to this type from the input type.

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> 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<D> OwoColorize for D

Source§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
Source§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
Source§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
Source§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
Source§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
Source§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
Source§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
Source§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
Source§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
Source§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
Source§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
Source§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
Source§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
Source§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
Source§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
Source§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
Source§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
Source§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
Source§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
Source§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
Source§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
Source§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
Source§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
Source§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
Source§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
Source§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
Source§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
Source§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
Source§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
Source§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
Source§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
Source§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
Source§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
Source§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
Source§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
Source§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
Source§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
Source§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
Source§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
Source§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
Source§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
Source§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
Source§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
Source§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
Source§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
Source§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
Source§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
Source§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more
Source§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more
Source§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
Source§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
Source§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
Source§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
Source§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
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> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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