ConsensusError

reth::consensus

Enum ConsensusError 

pub enum ConsensusError {

Show 46 variants    HeaderGasUsedExceedsGasLimit {
        gas_used: u64,
        gas_limit: u64,
    },
    HeaderGasLimitExceedsMax {
        gas_limit: u64,
    },
    BlockGasUsed {
        gas: GotExpected<u64>,
        gas_spent_by_tx: Vec<(u64, u64)>,
    },
    BodyOmmersHashDiff(GotExpectedBoxed<FixedBytes<32>>),
    BodyStateRootDiff(GotExpectedBoxed<FixedBytes<32>>),
    BodyTransactionRootDiff(GotExpectedBoxed<FixedBytes<32>>),
    BodyReceiptRootDiff(GotExpectedBoxed<FixedBytes<32>>),
    BodyBloomLogDiff(GotExpectedBoxed<Bloom>),
    BodyWithdrawalsRootDiff(GotExpectedBoxed<FixedBytes<32>>),
    BodyRequestsHashDiff(GotExpectedBoxed<FixedBytes<32>>),
    BlockKnown {
        hash: FixedBytes<32>,
        number: u64,
    },
    ParentUnknown {
        hash: FixedBytes<32>,
    },
    ParentBlockNumberMismatch {
        parent_block_number: u64,
        block_number: u64,
    },
    ParentHashMismatch(GotExpectedBoxed<FixedBytes<32>>),
    TimestampIsInFuture {
        timestamp: u64,
        present_timestamp: u64,
    },
    BaseFeeMissing,
    TransactionSignerRecoveryError,
    ExtraDataExceedsMax {
        len: usize,
    },
    TheMergeDifficultyIsNotZero,
    TheMergeNonceIsNotZero,
    TheMergeOmmerRootIsNotEmpty,
    WithdrawalsRootMissing,
    RequestsHashMissing,
    WithdrawalsRootUnexpected,
    RequestsHashUnexpected,
    BodyWithdrawalsMissing,
    BodyRequestsMissing,
    BlobGasUsedMissing,
    BlobGasUsedUnexpected,
    ExcessBlobGasMissing,
    ExcessBlobGasUnexpected,
    ParentBeaconBlockRootMissing,
    ParentBeaconBlockRootUnexpected,
    BlobGasUsedExceedsMaxBlobGasPerBlock {
        blob_gas_used: u64,
        max_blob_gas_per_block: u64,
    },
    BlobGasUsedNotMultipleOfBlobGasPerBlob {
        blob_gas_used: u64,
        blob_gas_per_blob: u64,
    },
    ExcessBlobGasNotMultipleOfBlobGasPerBlob {
        excess_blob_gas: u64,
        blob_gas_per_blob: u64,
    },
    BlobGasUsedDiff(GotExpected<u64>),
    InvalidTransaction(InvalidTransactionError),
    BaseFeeDiff(GotExpected<u64>),
    ExcessBlobGasDiff {
        diff: GotExpected<u64>,
        parent_excess_blob_gas: u64,
        parent_blob_gas_used: u64,
    },
    GasLimitInvalidIncrease {
        parent_gas_limit: u64,
        child_gas_limit: u64,
    },
    GasLimitInvalidMinimum {
        child_gas_limit: u64,
    },
    GasLimitInvalidBlockMaximum {
        block_gas_limit: u64,
    },
    GasLimitInvalidDecrease {
        parent_gas_limit: u64,
        child_gas_limit: u64,
    },
    TimestampIsInPast {
        parent_timestamp: u64,
        timestamp: u64,
    },
    Other(String),

}
Expand description

Consensus Errors

Variants§

§

HeaderGasUsedExceedsGasLimit

Error when the gas used in the header exceeds the gas limit.

Fields

§gas_used: u64

The gas used in the block header.

§gas_limit: u64

The gas limit in the block header.

§

HeaderGasLimitExceedsMax

Error when the gas the gas limit is more than the maximum allowed.

Fields

§gas_limit: u64

The gas limit in the block header.

§

BlockGasUsed

Error when block gas used doesn’t match expected value

Fields

§gas: GotExpected<u64>

The gas diff.

§gas_spent_by_tx: Vec<(u64, u64)>

Gas spent by each transaction

§

BodyOmmersHashDiff(GotExpectedBoxed<FixedBytes<32>>)

Error when the hash of block ommer is different from the expected hash.

§

BodyStateRootDiff(GotExpectedBoxed<FixedBytes<32>>)

Error when the state root in the block is different from the expected state root.

§

BodyTransactionRootDiff(GotExpectedBoxed<FixedBytes<32>>)

Error when the transaction root in the block is different from the expected transaction root.

§

BodyReceiptRootDiff(GotExpectedBoxed<FixedBytes<32>>)

Error when the receipt root in the block is different from the expected receipt root.

§

BodyBloomLogDiff(GotExpectedBoxed<Bloom>)

Error when header bloom filter is different from the expected bloom filter.

§

BodyWithdrawalsRootDiff(GotExpectedBoxed<FixedBytes<32>>)

Error when the withdrawals root in the block is different from the expected withdrawals root.

§

BodyRequestsHashDiff(GotExpectedBoxed<FixedBytes<32>>)

Error when the requests hash in the block is different from the expected requests hash.

§

BlockKnown

Error when a block with a specific hash and number is already known.

Fields

§hash: FixedBytes<32>

The hash of the known block.

§number: u64

The block number of the known block.

§

ParentUnknown

Error when the parent hash of a block is not known.

Fields

§hash: FixedBytes<32>

The hash of the unknown parent block.

§

ParentBlockNumberMismatch

Error when the block number does not match the parent block number.

Fields

§parent_block_number: u64

The parent block number.

§block_number: u64

The block number.

§

ParentHashMismatch(GotExpectedBoxed<FixedBytes<32>>)

Error when the parent hash does not match the expected parent hash.

§

TimestampIsInFuture

Error when the block timestamp is in the future compared to our clock time.

Fields

§timestamp: u64

The block’s timestamp.

§present_timestamp: u64

The current timestamp.

§

BaseFeeMissing

Error when the base fee is missing.

§

TransactionSignerRecoveryError

Error when there is a transaction signer recovery error.

§

ExtraDataExceedsMax

Error when the extra data length exceeds the maximum allowed.

Fields

§len: usize

The length of the extra data.

§

TheMergeDifficultyIsNotZero

Error when the difficulty after a merge is not zero.

§

TheMergeNonceIsNotZero

Error when the nonce after a merge is not zero.

§

TheMergeOmmerRootIsNotEmpty

Error when the ommer root after a merge is not empty.

§

WithdrawalsRootMissing

Error when the withdrawals root is missing.

§

RequestsHashMissing

Error when the requests hash is missing.

§

WithdrawalsRootUnexpected

Error when an unexpected withdrawals root is encountered.

§

RequestsHashUnexpected

Error when an unexpected requests hash is encountered.

§

BodyWithdrawalsMissing

Error when withdrawals are missing.

§

BodyRequestsMissing

Error when requests are missing.

§

BlobGasUsedMissing

Error when blob gas used is missing.

§

BlobGasUsedUnexpected

Error when unexpected blob gas used is encountered.

§

ExcessBlobGasMissing

Error when excess blob gas is missing.

§

ExcessBlobGasUnexpected

Error when unexpected excess blob gas is encountered.

§

ParentBeaconBlockRootMissing

Error when the parent beacon block root is missing.

§

ParentBeaconBlockRootUnexpected

Error when an unexpected parent beacon block root is encountered.

§

BlobGasUsedExceedsMaxBlobGasPerBlock

Error when blob gas used exceeds the maximum allowed.

Fields

§blob_gas_used: u64

The actual blob gas used.

§max_blob_gas_per_block: u64

The maximum allowed blob gas per block.

§

BlobGasUsedNotMultipleOfBlobGasPerBlob

Error when blob gas used is not a multiple of blob gas per blob.

Fields

§blob_gas_used: u64

The actual blob gas used.

§blob_gas_per_blob: u64

The blob gas per blob.

§

ExcessBlobGasNotMultipleOfBlobGasPerBlob

Error when excess blob gas is not a multiple of blob gas per blob.

Fields

§excess_blob_gas: u64

The actual excess blob gas.

§blob_gas_per_blob: u64

The blob gas per blob.

§

BlobGasUsedDiff(GotExpected<u64>)

Error when the blob gas used in the header does not match the expected blob gas used.

§

InvalidTransaction(InvalidTransactionError)

Error for a transaction that violates consensus.

§

BaseFeeDiff(GotExpected<u64>)

Error when the block’s base fee is different from the expected base fee.

§

ExcessBlobGasDiff

Error when there is an invalid excess blob gas.

Fields

§diff: GotExpected<u64>

The excess blob gas diff.

§parent_excess_blob_gas: u64

The parent excess blob gas.

§parent_blob_gas_used: u64

The parent blob gas used.

§

GasLimitInvalidIncrease

Error when the child gas limit exceeds the maximum allowed increase.

Fields

§parent_gas_limit: u64

The parent gas limit.

§child_gas_limit: u64

The child gas limit.

§

GasLimitInvalidMinimum

Error indicating that the child gas limit is below the minimum allowed limit.

This error occurs when the child gas limit is less than the specified minimum gas limit.

Fields

§child_gas_limit: u64

The child gas limit.

§

GasLimitInvalidBlockMaximum

Error indicating that the block gas limit is above the allowed maximum.

This error occurs when the gas limit is more than the specified maximum gas limit.

Fields

§block_gas_limit: u64

block gas limit.

§

GasLimitInvalidDecrease

Error when the child gas limit exceeds the maximum allowed decrease.

Fields

§parent_gas_limit: u64

The parent gas limit.

§child_gas_limit: u64

The child gas limit.

§

TimestampIsInPast

Error when the block timestamp is in the past compared to the parent timestamp.

Fields

§parent_timestamp: u64

The parent block’s timestamp.

§timestamp: u64

The block’s timestamp.

§

Other(String)

Other, likely an injected L2 error.

Implementations§

§

impl ConsensusError

pub const fn is_state_root_error(&self) -> bool

Returns true if the error is a state root error.

Trait Implementations§

§

impl Clone for ConsensusError

§

fn clone(&self) -> ConsensusError

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
§

impl Debug for ConsensusError

§

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

Formats the value using the given formatter. Read more
§

impl Display for ConsensusError

§

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

Formats the value using the given formatter. Read more
§

impl Error for ConsensusError

§

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<ConsensusError> for BlockErrorKind

§

fn from(source: ConsensusError) -> BlockErrorKind

Converts to this type from the input type.
§

impl From<ConsensusError> for BlockImportError

§

fn from(source: ConsensusError) -> BlockImportError

Converts to this type from the input type.
§

impl From<ConsensusError> for FileClientError

§

fn from(source: ConsensusError) -> FileClientError

Converts to this type from the input type.
§

impl From<ConsensusError> for InsertBlockErrorKind

§

fn from(source: ConsensusError) -> InsertBlockErrorKind

Converts to this type from the input type.
§

impl From<ConsensusError> for InsertBlockValidationError

§

fn from(source: ConsensusError) -> InsertBlockValidationError

Converts to this type from the input type.
§

impl From<ConsensusError> for RethError

§

fn from(source: ConsensusError) -> RethError

Converts to this type from the input type.
§

impl From<InvalidTransactionError> for ConsensusError

§

fn from(value: InvalidTransactionError) -> ConsensusError

Converts to this type from the input type.
§

impl PartialEq for ConsensusError

§

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

impl<Ok> ToRpcResult<Ok, ConsensusError> for Result<Ok, ConsensusError>

§

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

Converts this type into an [RpcResult]
§

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

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

fn map_internal_err_with_data<'a, F, M>( self, op: F, ) -> Result<Ok, ErrorObject<'static>>
where F: FnOnce(ConsensusError) -> (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.
§

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

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

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 ConsensusError

§

impl StructuralPartialEq for ConsensusError

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, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit #126799)
Performs copy-assignment from self to dest. 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
§

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

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

§

fn propagate_header(self, header: HeaderName) -> PropagateHeader<Self>
where Self: Sized,

Propagate a header from the request to the response. Read more
§

fn add_extension<T>(self, value: T) -> AddExtension<Self, T>
where Self: Sized,

Add some shareable value to request extensions. Read more
§

fn map_request_body<F>(self, f: F) -> MapRequestBody<Self, F>
where Self: Sized,

Apply a transformation to the request body. Read more
§

fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>
where Self: Sized,

Apply a transformation to the response body. Read more
§

fn compression(self) -> Compression<Self>
where Self: Sized,

Compresses response bodies. Read more
§

fn decompression(self) -> Decompression<Self>
where Self: Sized,

Decompress response bodies. Read more
§

fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using HTTP status codes. Read more
§

fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using gRPC headers. Read more
§

fn follow_redirects(self) -> FollowRedirect<Self>
where Self: Sized,

Follow redirect resposes using the Standard policy. Read more
§

fn sensitive_headers( self, headers: impl IntoIterator<Item = HeaderName>, ) -> SetSensitiveRequestHeaders<SetSensitiveResponseHeaders<Self>>
where Self: Sized,

Mark headers as sensitive on both requests and responses. Read more
§

fn sensitive_request_headers( self, headers: impl IntoIterator<Item = HeaderName>, ) -> SetSensitiveRequestHeaders<Self>
where Self: Sized,

Mark headers as sensitive on requests. Read more
§

fn sensitive_response_headers( self, headers: impl IntoIterator<Item = HeaderName>, ) -> SetSensitiveResponseHeaders<Self>
where Self: Sized,

Mark headers as sensitive on responses. Read more
§

fn override_request_header<M>( self, header_name: HeaderName, make: M, ) -> SetRequestHeader<Self, M>
where Self: Sized,

Insert a header into the request. Read more
§

fn append_request_header<M>( self, header_name: HeaderName, make: M, ) -> SetRequestHeader<Self, M>
where Self: Sized,

Append a header into the request. Read more
§

fn insert_request_header_if_not_present<M>( self, header_name: HeaderName, make: M, ) -> SetRequestHeader<Self, M>
where Self: Sized,

Insert a header into the request, if the header is not already present. Read more
§

fn override_response_header<M>( self, header_name: HeaderName, make: M, ) -> SetResponseHeader<Self, M>
where Self: Sized,

Insert a header into the response. Read more
§

fn append_response_header<M>( self, header_name: HeaderName, make: M, ) -> SetResponseHeader<Self, M>
where Self: Sized,

Append a header into the response. Read more
§

fn insert_response_header_if_not_present<M>( self, header_name: HeaderName, make: M, ) -> SetResponseHeader<Self, M>
where Self: Sized,

Insert a header into the response, if the header is not already present. Read more
§

fn set_request_id<M>( self, header_name: HeaderName, make_request_id: M, ) -> SetRequestId<Self, M>
where Self: Sized, M: MakeRequestId,

Add request id header and extension. Read more
§

fn set_x_request_id<M>(self, make_request_id: M) -> SetRequestId<Self, M>
where Self: Sized, M: MakeRequestId,

Add request id header and extension, using x-request-id as the header name. Read more
§

fn propagate_request_id( self, header_name: HeaderName, ) -> PropagateRequestId<Self>
where Self: Sized,

Propgate request ids from requests to responses. Read more
§

fn propagate_x_request_id(self) -> PropagateRequestId<Self>
where Self: Sized,

Propgate request ids from requests to responses, using x-request-id as the header name. Read more
§

fn catch_panic(self) -> CatchPanic<Self, DefaultResponseForPanic>
where Self: Sized,

Catch panics and convert them into 500 Internal Server responses. Read more
§

fn request_body_limit(self, limit: usize) -> RequestBodyLimit<Self>
where Self: Sized,

Intercept requests with over-sized payloads and convert them into 413 Payload Too Large responses. Read more
§

fn trim_trailing_slash(self) -> NormalizePath<Self>
where Self: Sized,

Remove trailing slashes from paths. Read more
§

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§

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> ErasedDestructor for T
where T: 'static,

§

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

§

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

§

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:

  • HeaderGasUsedExceedsGasLimit: 23 bytes
  • HeaderGasLimitExceedsMax: 15 bytes
  • BlockGasUsed: 47 bytes
  • BodyOmmersHashDiff: 15 bytes
  • BodyStateRootDiff: 15 bytes
  • BodyTransactionRootDiff: 15 bytes
  • BodyReceiptRootDiff: 15 bytes
  • BodyBloomLogDiff: 15 bytes
  • BodyWithdrawalsRootDiff: 15 bytes
  • BodyRequestsHashDiff: 15 bytes
  • BlockKnown: 47 bytes
  • ParentUnknown: 32 bytes
  • ParentBlockNumberMismatch: 23 bytes
  • ParentHashMismatch: 15 bytes
  • TimestampIsInFuture: 23 bytes
  • BaseFeeMissing: 0 bytes
  • TransactionSignerRecoveryError: 0 bytes
  • ExtraDataExceedsMax: 15 bytes
  • TheMergeDifficultyIsNotZero: 0 bytes
  • TheMergeNonceIsNotZero: 0 bytes
  • TheMergeOmmerRootIsNotEmpty: 0 bytes
  • WithdrawalsRootMissing: 0 bytes
  • RequestsHashMissing: 0 bytes
  • WithdrawalsRootUnexpected: 0 bytes
  • RequestsHashUnexpected: 0 bytes
  • BodyWithdrawalsMissing: 0 bytes
  • BodyRequestsMissing: 0 bytes
  • BlobGasUsedMissing: 0 bytes
  • BlobGasUsedUnexpected: 0 bytes
  • ExcessBlobGasMissing: 0 bytes
  • ExcessBlobGasUnexpected: 0 bytes
  • ParentBeaconBlockRootMissing: 0 bytes
  • ParentBeaconBlockRootUnexpected: 0 bytes
  • BlobGasUsedExceedsMaxBlobGasPerBlock: 23 bytes
  • BlobGasUsedNotMultipleOfBlobGasPerBlob: 23 bytes
  • ExcessBlobGasNotMultipleOfBlobGasPerBlob: 23 bytes
  • BlobGasUsedDiff: 23 bytes
  • InvalidTransaction: 31 bytes
  • BaseFeeDiff: 23 bytes
  • ExcessBlobGasDiff: 39 bytes
  • GasLimitInvalidIncrease: 23 bytes
  • GasLimitInvalidMinimum: 15 bytes
  • GasLimitInvalidBlockMaximum: 15 bytes
  • GasLimitInvalidDecrease: 23 bytes
  • TimestampIsInPast: 23 bytes
  • Other: 31 bytes