anvil_zksync_core::node

Struct InMemoryNode

Source 
pub struct InMemoryNode { /* private fields */ }
Expand description

In-memory node, that can be used for local & unit testing. It also supports the option of forking testnet/mainnet. All contents are removed when object is destroyed.

Implementations§

Source§

impl InMemoryNode

Source

pub async fn trace_block_impl( &self, block_id: BlockId, options: Option<TracerConfig>, ) -> Result<CallTracerBlockResult>

Source

pub async fn trace_call_impl( &self, request: CallRequest, block: Option<BlockId>, options: Option<TracerConfig>, ) -> Result<CallTracerResult, Web3Error>

Source

pub async fn trace_transaction_impl( &self, tx_hash: H256, options: Option<TracerConfig>, ) -> Result<Option<CallTracerResult>>

Source§

impl InMemoryNode

Source

pub async fn call_impl(&self, req: CallRequest) -> Result<Bytes, Web3Error>

Source

pub async fn send_raw_transaction_impl( &self, tx_bytes: Bytes, ) -> Result<H256, Web3Error>

Source

pub async fn send_transaction_impl( &self, tx: CallRequest, ) -> Result<H256, Web3Error>

Source§

impl InMemoryNode

Source

pub async fn get_balance_impl( &self, address: Address, _block: Option<BlockIdVariant>, ) -> Result<U256>

Source

pub async fn get_block_impl( &self, block_id: BlockId, full_transactions: bool, ) -> Result<Option<Block<TransactionVariant>>>

Source

pub async fn get_code_impl( &self, address: Address, _block: Option<BlockIdVariant>, ) -> Result<Bytes>

Source

pub async fn get_transaction_count_impl( &self, address: Address, _block: Option<BlockIdVariant>, ) -> Result<U256>

Source

pub async fn get_transaction_receipt_impl( &self, hash: H256, ) -> Result<Option<TransactionReceipt>>

Source

pub async fn get_transaction_by_hash_impl( &self, hash: H256, ) -> Result<Option<Transaction>>

Source

pub async fn get_block_number_impl(&self) -> Result<U64>

Source

pub async fn estimate_gas_impl( &self, req: CallRequest, _block: Option<BlockNumber>, ) -> Result<U256, Web3Error>

Source

pub async fn gas_price_impl(&self) -> Result<U256>

Source

pub async fn new_filter_impl(&self, filter: Filter) -> Result<U256>

Source

pub async fn new_block_filter_impl(&self) -> Result<U256>

Source

pub async fn new_pending_transaction_filter_impl(&self) -> Result<U256>

Source

pub async fn uninstall_filter_impl(&self, id: U256) -> Result<bool>

Source

pub async fn get_logs_impl(&self, filter: Filter) -> Result<Vec<Log>>

Source

pub async fn get_filter_logs_impl(&self, id: U256) -> Result<FilterChanges>

Source

pub async fn get_filter_changes_impl(&self, id: U256) -> Result<FilterChanges>

Source

pub async fn get_block_transaction_count_impl( &self, block_id: BlockId, ) -> Result<Option<U256>, Web3Error>

Source

pub async fn get_storage_impl( &self, address: Address, idx: U256, block: Option<BlockIdVariant>, ) -> Result<H256, Web3Error>

Source

pub async fn get_transaction_by_block_and_index_impl( &self, block_id: BlockId, index: Index, ) -> Result<Option<Transaction>>

Source

pub fn protocol_version_impl(&self) -> String

Source

pub fn syncing_impl(&self) -> SyncState

Source

pub async fn accounts_impl(&self) -> Result<Vec<H160>>

Source

pub async fn fee_history_impl( &self, block_count: u64, _newest_block: BlockNumber, reward_percentiles: Option<Vec<f32>>, ) -> Result<FeeHistory>

Source§

impl InMemoryNode

Source

pub fn new( inner: Arc<RwLock<InMemoryNodeInner>>, blockchain: Box<dyn ReadBlockchain>, storage: Box<dyn ReadStorageDyn>, fork: Box<dyn ForkSource>, node_handle: NodeExecutorHandle, observability: Option<Observability>, time: Box<dyn ReadTime>, impersonation: ImpersonationManager, pool: TxPool, sealer_state: BlockSealerState, system_contracts: SystemContracts, storage_key_layout: StorageKeyLayout, ) -> Self

Source

pub async fn replay_txs(&self, txs: Vec<Transaction>) -> Result<()>

Replays transactions consequently in a new block. All transactions are expected to be executable and will become a part of the resulting block.

Source

pub async fn set_rich_account(&self, address: H160, balance: U256)

Adds a lot of tokens to a given account with a specified balance.

Source

pub async fn run_l2_call( &self, l2_tx: L2Tx, base_contracts: BaseSystemContracts, ) -> Result<ExecutionResult>

Runs L2 ‘eth call’ method - that doesn’t commit to a block.

Source

pub async fn override_bytecode( &self, address: Address, bytecode: Vec<u8>, ) -> Result<()>

Source

pub async fn dump_state( &self, preserve_historical_states: bool, ) -> Result<Bytes>

Source

pub async fn load_state(&self, buf: Bytes) -> Result<bool, LoadStateError>

Source

pub async fn get_chain_id(&self) -> Result<u32>

Source

pub async fn get_show_calls(&self) -> Result<String>

Source

pub async fn get_show_outputs(&self) -> Result<bool>

Source

pub fn get_current_timestamp(&self) -> Result<u64>

Source

pub async fn set_show_calls(&self, show_calls: ShowCalls) -> Result<String>

Source

pub async fn set_show_outputs(&self, value: bool) -> Result<bool>

Source

pub async fn set_show_storage_logs( &self, show_storage_logs: ShowStorageLogs, ) -> Result<String>

Source

pub async fn set_show_vm_details( &self, show_vm_details: ShowVMDetails, ) -> Result<String>

Source

pub async fn set_show_gas_details( &self, show_gas_details: ShowGasDetails, ) -> Result<String>

Source

pub async fn set_resolve_hashes(&self, value: bool) -> Result<bool>

Source

pub async fn set_show_node_config(&self, value: bool) -> Result<bool>

Source

pub async fn set_show_tx_summary(&self, value: bool) -> Result<bool>

Source

pub async fn set_show_event_logs(&self, value: bool) -> Result<bool>

Source

pub async fn set_disable_console_log(&self, value: bool) -> Result<bool>

Source

pub fn set_log_level(&self, level: LogLevel) -> Result<bool>

Source

pub fn set_logging(&self, directive: String) -> Result<bool>

Source

pub async fn chain_id(&self) -> L2ChainId

Source§

impl InMemoryNode

Source

pub fn test_config( fork_client_opt: Option<ForkClient>, config: TestNodeConfig, ) -> Self

Source

pub fn test(fork_client_opt: Option<ForkClient>) -> Self

Source§

impl InMemoryNode

Source

pub async fn increase_time(&self, time_delta_seconds: u64) -> Result<u64>

Increase the current timestamp for the node

§Parameters
  • time_delta: The number of seconds to increase time by
§Returns

The applied time delta to current_timestamp value for the InMemoryNodeInner.

Source

pub async fn set_next_block_timestamp(&self, timestamp: u64) -> Result<()>

Set the current timestamp for the node. The timestamp must be in the future.

§Parameters
  • timestamp: The timestamp to set the time to
§Returns

The new timestamp value for the InMemoryNodeInner.

Source

pub async fn set_time(&self, timestamp: u64) -> Result<i128>

Set the current timestamp for the node. Warning: This will allow you to move backwards in time, which may cause new blocks to appear to be mined before old blocks. This will result in an invalid state.

§Parameters
  • time: The timestamp to set the time to
§Returns

The difference between the current_timestamp and the new timestamp for the InMemoryNodeInner.

Source

pub async fn mine_block(&self) -> Result<L2BlockNumber>

Force a single block to be mined.

Will mine an empty block (containing zero transactions)

§Returns

The string “0x0”.

Source

pub async fn mine_detailed(&self) -> Result<Block<DetailedTransaction>>

Source

pub async fn snapshot(&self) -> Result<U64>

Snapshot the state of the blockchain at the current block. Takes no parameters. Returns the id of the snapshot that was created. A snapshot can only be reverted once. After a successful evm_revert, the same snapshot id cannot be used again. Consider creating a new snapshot after each evm_revert if you need to revert to the same point multiple times.

§Returns

The U64 identifier for this snapshot.

Source

pub async fn revert_snapshot(&self, snapshot_id: U64) -> Result<bool>

Revert the state of the blockchain to a previous snapshot. Takes a single parameter, which is the snapshot id to revert to. This deletes the given snapshot, as well as any snapshots taken after (e.g.: reverting to id 0x1 will delete snapshots with ids 0x1, 0x2, etc.)

§Parameters
  • snapshot_id: The snapshot id to revert.
§Returns

true if a snapshot was reverted, otherwise false.

Source

pub async fn set_balance(&self, address: Address, balance: U256) -> Result<bool>

Source

pub async fn set_nonce(&self, address: Address, nonce: U256) -> Result<bool>

Source

pub async fn mine_blocks( &self, num_blocks: Option<U64>, interval: Option<U64>, ) -> Result<()>

Source

pub fn get_automine(&self) -> Result<bool>

Source

pub async fn reset_network( &self, reset_spec: Option<ResetRequest>, ) -> Result<bool>

Source

pub fn auto_impersonate_account(&self, enabled: bool)

Source

pub fn impersonate_account(&self, address: Address) -> Result<bool>

Source

pub fn stop_impersonating_account(&self, address: Address) -> Result<bool>

Source

pub async fn set_code(&self, address: Address, code: String) -> Result<()>

Source

pub async fn set_storage_at( &self, address: Address, slot: U256, value: U256, ) -> Result<bool>

Source

pub fn set_logging_enabled(&self, enable: bool) -> Result<()>

Source

pub fn get_immediate_sealing(&self) -> Result<bool>

Source

pub async fn set_block_timestamp_interval(&self, seconds: u64) -> Result<()>

Source

pub async fn remove_block_timestamp_interval(&self) -> Result<bool>

Source

pub async fn set_immediate_sealing(&self, enable: bool) -> Result<()>

Source

pub async fn set_interval_sealing(&self, seconds: u64) -> Result<()>

Source

pub fn drop_transaction(&self, hash: H256) -> Result<Option<H256>>

Source

pub fn drop_all_transactions(&self) -> Result<()>

Source

pub fn remove_pool_transactions(&self, address: Address) -> Result<()>

Source

pub async fn set_next_block_base_fee_per_gas( &self, base_fee: U256, ) -> Result<()>

Source

pub async fn set_rpc_url(&self, url: String) -> Result<()>

Source

pub async fn set_chain_id(&self, id: u32) -> Result<()>

Source§

impl InMemoryNode

Source

pub async fn estimate_fee_impl( &self, req: CallRequest, ) -> Result<Fee, Web3Error>

Source

pub async fn estimate_gas_l1_to_l2( &self, req: CallRequest, ) -> Result<U256, Web3Error>

Source

pub async fn get_raw_block_transactions_impl( &self, block_number: L2BlockNumber, ) -> Result<Vec<Transaction>, Web3Error>

Source

pub async fn get_bridge_contracts_impl( &self, ) -> Result<BridgeAddresses, Web3Error>

Source

pub async fn get_confirmed_tokens_impl( &self, from: u32, limit: u8, ) -> Result<Vec<Token>>

Source

pub async fn get_all_account_balances_impl( &self, address: Address, ) -> Result<HashMap<Address, U256>, Web3Error>

Source

pub async fn get_block_details_impl( &self, block_number: L2BlockNumber, ) -> Result<Option<BlockDetails>>

Source

pub async fn get_transaction_details_impl( &self, hash: H256, ) -> Result<Option<TransactionDetails>>

Source

pub async fn get_bytecode_by_hash_impl( &self, hash: H256, ) -> Result<Option<Vec<u8>>>

Source

pub async fn get_base_token_l1_address_impl(&self) -> Result<Address>

Source

pub async fn get_l2_to_l1_log_proof_impl( &self, tx_hash: H256, index: Option<usize>, ) -> Result<Option<L2ToL1LogProof>>

Trait Implementations§

Source§

impl Clone for InMemoryNode

Source§

fn clone(&self) -> InMemoryNode

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

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)
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<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, 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
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

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

Immutable access to a value. Read more
§

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

Mutable access to a value. Read more
§

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T> TryConv for T

§

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

Attempts to convert self into T using TryInto<T>. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

§

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

§

impl<T> MaybeSendSync for T