reth::providers

Enum ProviderError

pub enum ProviderError {

Show 39 variants    Database(DatabaseError),
    Rlp(Error),
    FsPathError(String),
    NippyJar(String),
    TrieWitnessError(String),
    SenderRecoveryError,
    BlockHashNotFound(FixedBytes<32>),
    BlockBodyIndicesNotFound(u64),
    StorageChangesetNotFound {
        block_number: u64,
        address: Address,
        storage_key: Box<FixedBytes<32>>,
    },
    AccountChangesetNotFound {
        block_number: u64,
        address: Address,
    },
    TotalDifficultyNotFound(u64),
    HeaderNotFound(HashOrNumber),
    TransactionNotFound(HashOrNumber),
    ReceiptNotFound(HashOrNumber),
    BestBlockNotFound,
    FinalizedBlockNotFound,
    SafeBlockNotFound,
    MismatchOfTransactionAndSenderId {
        tx_id: u64,
    },
    BlockBodyTransactionCount,
    CacheServiceUnavailable,
    UnknownBlockHash(FixedBytes<32>),
    StateForHashNotFound(FixedBytes<32>),
    StateForNumberNotFound(u64),
    BlockNumberForTransactionIndexNotFound,
    StateRootMismatch(Box<RootMismatch>),
    UnwindStateRootMismatch(Box<RootMismatch>),
    StateAtBlockPruned(u64),
    UnsupportedProvider,
    MissingStaticFilePath(StaticFileSegment, PathBuf),
    MissingStaticFileBlock(StaticFileSegment, u64),
    MissingStaticFileTx(StaticFileSegment, u64),
    FinalizedStaticFile(StaticFileSegment, u64),
    UnexpectedStaticFileBlockNumber(StaticFileSegment, u64, u64),
    UnexpectedStaticFileTxNumber(StaticFileSegment, u64, u64),
    ReadOnlyStaticFileAccess,
    BlockNumberOverflow(Uint<256, 4>),
    ConsistentView(Box<ConsistentViewError>),
    StorageLockError(StorageLockError),
    UnifiedStorageWriterError(UnifiedStorageWriterError),

}
Expand description

Bundled errors variants thrown by various providers.

Variants§

§

Database(DatabaseError)

Database error.

§

Rlp(Error)

RLP error.

§

FsPathError(String)

Filesystem path error.

§

NippyJar(String)

Nippy jar error.

§

TrieWitnessError(String)

Trie witness error.

§

SenderRecoveryError

Error when recovering the sender for a transaction

§

BlockHashNotFound(FixedBytes<32>)

The header number was not found for the given block hash.

§

BlockBodyIndicesNotFound(u64)

A block body is missing.

§

StorageChangesetNotFound

The transition ID was found for the given address and storage key, but the changeset was not found.

Fields

§block_number: u64

The block number found for the address and storage key.

§address: Address

The account address.

§storage_key: Box<FixedBytes<32>>

The storage key.

§

AccountChangesetNotFound

The block number was found for the given address, but the changeset was not found.

Fields

§block_number: u64

Block number found for the address.

§address: Address

The account address.

§

TotalDifficultyNotFound(u64)

The total difficulty for a block is missing.

§

HeaderNotFound(HashOrNumber)

when required header related data was not found but was required.

§

TransactionNotFound(HashOrNumber)

The specific transaction is missing.

§

ReceiptNotFound(HashOrNumber)

The specific receipt is missing

§

BestBlockNotFound

Unable to find the best block.

§

FinalizedBlockNotFound

Unable to find the finalized block.

§

SafeBlockNotFound

Unable to find the safe block.

§

MismatchOfTransactionAndSenderId

Mismatch of sender and transaction.

Fields

§tx_id: u64

The transaction ID.

§

BlockBodyTransactionCount

Block body wrong transaction count.

§

CacheServiceUnavailable

Thrown when the cache service task dropped.

§

UnknownBlockHash(FixedBytes<32>)

Thrown when we failed to lookup a block for the pending state.

§

StateForHashNotFound(FixedBytes<32>)

Thrown when we were unable to find a state for a block hash.

§

StateForNumberNotFound(u64)

Thrown when we were unable to find a state for a block number.

§

BlockNumberForTransactionIndexNotFound

Unable to find the block number for a given transaction index.

§

StateRootMismatch(Box<RootMismatch>)

Root mismatch.

§

UnwindStateRootMismatch(Box<RootMismatch>)

Root mismatch during unwind

§

StateAtBlockPruned(u64)

State is not available for the given block number because it is pruned.

§

UnsupportedProvider

Provider does not support this particular request.

§

MissingStaticFilePath(StaticFileSegment, PathBuf)

Available on crate feature std only.

Static File is not found at specified path.

§

MissingStaticFileBlock(StaticFileSegment, u64)

Static File is not found for requested block.

§

MissingStaticFileTx(StaticFileSegment, u64)

Static File is not found for requested transaction.

§

FinalizedStaticFile(StaticFileSegment, u64)

Static File is finalized and cannot be written to.

§

UnexpectedStaticFileBlockNumber(StaticFileSegment, u64, u64)

Trying to insert data from an unexpected block number.

§

UnexpectedStaticFileTxNumber(StaticFileSegment, u64, u64)

Trying to insert data from an unexpected block number.

§

ReadOnlyStaticFileAccess

Static File Provider was initialized as read-only.

§

BlockNumberOverflow(Uint<256, 4>)

Error encountered when the block number conversion from U256 to u64 causes an overflow.

§

ConsistentView(Box<ConsistentViewError>)

Consistent view error.

§

StorageLockError(StorageLockError)

Storage lock error.

§

UnifiedStorageWriterError(UnifiedStorageWriterError)

Storage writer error.

Trait Implementations§

§

impl Clone for ProviderError

§

fn clone(&self) -> ProviderError

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

impl Debug for ProviderError

§

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

Formats the value using the given formatter. Read more
§

impl Display for ProviderError

§

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

Formats the value using the given formatter. Read more
§

impl Error for ProviderError

§

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()
Read more
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 #99301)
Provides type-based access to context intended for error reports. Read more
§

impl From<ConsistentViewError> for ProviderError

§

fn from(error: ConsistentViewError) -> ProviderError

Converts to this type from the input type.
§

impl From<DatabaseError> for ProviderError

§

fn from(error: DatabaseError) -> ProviderError

Converts to this type from the input type.
§

impl From<Error> for ProviderError

§

fn from(error: Error) -> ProviderError

Converts to this type from the input type.
§

impl From<ParallelStateRootError> for ProviderError

§

fn from(error: ParallelStateRootError) -> ProviderError

Converts to this type from the input type.
Source§

impl From<ProviderError> for AdvancePersistenceError

Source§

fn from(source: ProviderError) -> AdvancePersistenceError

Converts to this type from the input type.
§

impl From<ProviderError> for BlockExecutionError

§

fn from(error: ProviderError) -> BlockExecutionError

Converts to this type from the input type.
§

impl From<ProviderError> for CanonicalError

§

fn from(source: ProviderError) -> CanonicalError

Converts to this type from the input type.
Source§

impl From<ProviderError> for DownloadError

Source§

fn from(error: ProviderError) -> DownloadError

Converts to this type from the input type.
Source§

impl From<ProviderError> for EthApiError

Source§

fn from(error: ProviderError) -> EthApiError

Converts to this type from the input type.
Source§

impl From<ProviderError> for EthFilterError

Source§

fn from(err: ProviderError) -> EthFilterError

Converts to this type from the input type.
§

impl From<ProviderError> for InitDatabaseError

§

fn from(source: ProviderError) -> InitDatabaseError

Converts to this type from the input type.
§

impl From<ProviderError> for InsertBlockErrorKind

§

fn from(source: ProviderError) -> InsertBlockErrorKind

Converts to this type from the input type.
§

impl From<ProviderError> for InsertBlockErrorKindTwo

§

fn from(source: ProviderError) -> InsertBlockErrorKindTwo

Converts to this type from the input type.
§

impl From<ProviderError> for InsertBlockFatalError

§

fn from(source: ProviderError) -> InsertBlockFatalError

Converts to this type from the input type.
§

impl From<ProviderError> for InternalBlockExecutionError

§

fn from(value: ProviderError) -> InternalBlockExecutionError

Converts to this type from the input type.
§

impl From<ProviderError> for ParallelStateRootError

§

fn from(source: ProviderError) -> ParallelStateRootError

Converts to this type from the input type.
§

impl From<ProviderError> for PayloadBuilderError

§

fn from(error: ProviderError) -> PayloadBuilderError

Converts to this type from the input type.
Source§

impl From<ProviderError> for PersistenceError

Source§

fn from(source: ProviderError) -> PersistenceError

Converts to this type from the input type.
§

impl From<ProviderError> for PipelineError

§

fn from(source: ProviderError) -> PipelineError

Converts to this type from the input type.
§

impl From<ProviderError> for PrunerError

§

fn from(source: ProviderError) -> PrunerError

Converts to this type from the input type.
Source§

impl From<ProviderError> for RethError

Source§

fn from(source: ProviderError) -> RethError

Converts to this type from the input type.
§

impl From<ProviderError> for StageError

§

fn from(source: ProviderError) -> StageError

Converts to this type from the input type.
§

impl From<StateProofError> for ProviderError

§

fn from(value: StateProofError) -> ProviderError

Converts to this type from the input type.
§

impl From<StorageLockError> for ProviderError

§

fn from(error: StorageLockError) -> ProviderError

Converts to this type from the input type.
§

impl From<TrieWitnessError> for ProviderError

§

fn from(error: TrieWitnessError) -> ProviderError

Converts to this type from the input type.
§

impl From<UnifiedStorageWriterError> for ProviderError

§

fn from(error: UnifiedStorageWriterError) -> ProviderError

Converts to this type from the input type.
§

impl PartialEq for ProviderError

§

fn eq(&self, other: &ProviderError) -> 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<Ok> ToRpcResult<Ok, ProviderError> for Result<Ok, ProviderError>

Source§

fn map_rpc_err<'a, F, M>(self, op: F) -> Result<Ok, ErrorObject<'static>>
where F: FnOnce(ProviderError) -> (i32, M, Option<&'a [u8]>), M: Into<String>,

Converts this type into an [RpcResult]
Source§

fn map_internal_err<'a, F, M>(self, op: F) -> Result<Ok, ErrorObject<'static>>
where F: FnOnce(ProviderError) -> M, M: Into<String>,

Converts this type into an [RpcResult] with the [jsonrpsee_types::error::INTERNAL_ERROR_CODE] and the given message.
Source§

fn map_internal_err_with_data<'a, F, M>( self, op: F, ) -> Result<Ok, ErrorObject<'static>>
where F: FnOnce(ProviderError) -> (M, &'a [u8]), M: Into<String>,

Converts this type into an [RpcResult] with the [jsonrpsee_types::error::INTERNAL_ERROR_CODE] and given message and data.
Source§

fn with_message(self, msg: &str) -> Result<Ok, ErrorObject<'static>>

Adds a message to the error variant and returns an internal Error. Read more
Source§

fn to_rpc_result(self) -> Result<Ok, ErrorObject<'static>>
where Err: Display,

Converts result to [RpcResult] by converting error variant to [jsonrpsee_types::error::ErrorObject]
§

impl Eq for ProviderError

§

impl StructuralPartialEq for ProviderError

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

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit #126799)
Performs copy-assignment from self to dst. Read more
§

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

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<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> 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> IntoEthApiError for T
where EthApiError: From<T>,

Source§

fn into_eth_err<E>(self) -> E
where E: FromEthApiError,

Converts into error via EthApiError.
§

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.
§

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

§

fn try_to_compact_string(&self) -> Result<CompactString, ToCompactStringError>

Fallible version of [ToCompactString::to_compact_string()] Read more
§

fn to_compact_string(&self) -> CompactString

Converts the given value to a [CompactString]. Read more
§

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

§

fn to_line(&self) -> Line<'_>

Converts the value to a [Line].
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> ToSpan for T
where T: Display,

§

fn to_span(&self) -> Span<'_>

Converts the value to a [Span].
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
§

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

§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

§

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

§

fn to_text(&self) -> Text<'_>

Converts the value to a [Text].
§

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
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
§

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

§

impl<T> MaybeDebug for T
where T: Debug,

§

impl<T> MaybeSend for T
where T: Send,

§

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: 48 bytes

Size for each variant:

  • Database: 47 bytes
  • Rlp: 31 bytes
  • FsPathError: 31 bytes
  • NippyJar: 31 bytes
  • TrieWitnessError: 31 bytes
  • SenderRecoveryError: 0 bytes
  • BlockHashNotFound: 32 bytes
  • BlockBodyIndicesNotFound: 15 bytes
  • StorageChangesetNotFound: 39 bytes
  • AccountChangesetNotFound: 31 bytes
  • TotalDifficultyNotFound: 15 bytes
  • HeaderNotFound: 47 bytes
  • TransactionNotFound: 47 bytes
  • ReceiptNotFound: 47 bytes
  • BestBlockNotFound: 0 bytes
  • FinalizedBlockNotFound: 0 bytes
  • SafeBlockNotFound: 0 bytes
  • MismatchOfTransactionAndSenderId: 15 bytes
  • BlockBodyTransactionCount: 0 bytes
  • CacheServiceUnavailable: 0 bytes
  • UnknownBlockHash: 32 bytes
  • StateForHashNotFound: 32 bytes
  • StateForNumberNotFound: 15 bytes
  • BlockNumberForTransactionIndexNotFound: 0 bytes
  • StateRootMismatch: 15 bytes
  • UnwindStateRootMismatch: 15 bytes
  • StateAtBlockPruned: 15 bytes
  • UnsupportedProvider: 0 bytes
  • MissingStaticFilePath: 31 bytes
  • MissingStaticFileBlock: 15 bytes
  • MissingStaticFileTx: 15 bytes
  • FinalizedStaticFile: 15 bytes
  • UnexpectedStaticFileBlockNumber: 23 bytes
  • UnexpectedStaticFileTxNumber: 23 bytes
  • ReadOnlyStaticFileAccess: 0 bytes
  • BlockNumberOverflow: 39 bytes
  • ConsistentView: 15 bytes
  • StorageLockError: 31 bytes
  • UnifiedStorageWriterError: 47 bytes