pub enum Erc4626Subcommand {
Show 19 variants
Info {
vault: NameOrAddress,
human: bool,
block: Option<BlockId>,
rpc: RpcOpts,
},
Position {
vault: NameOrAddress,
owner: NameOrAddress,
human: bool,
block: Option<BlockId>,
rpc: RpcOpts,
},
Check {
vault: NameOrAddress,
account: Option<NameOrAddress>,
block: Option<BlockId>,
rpc: RpcOpts,
},
Asset {
vault: NameOrAddress,
block: Option<BlockId>,
rpc: RpcOpts,
},
TotalAssets {
vault: NameOrAddress,
block: Option<BlockId>,
rpc: RpcOpts,
},
ConvertToShares {
vault: NameOrAddress,
assets: U256,
block: Option<BlockId>,
rpc: RpcOpts,
},
ConvertToAssets {
vault: NameOrAddress,
shares: U256,
block: Option<BlockId>,
rpc: RpcOpts,
},
MaxDeposit {
vault: NameOrAddress,
receiver: NameOrAddress,
block: Option<BlockId>,
rpc: RpcOpts,
},
PreviewDeposit {
vault: NameOrAddress,
assets: U256,
block: Option<BlockId>,
rpc: RpcOpts,
},
Deposit {
vault: NameOrAddress,
assets: U256,
receiver: NameOrAddress,
send_tx: SendTxOpts,
tx: TxParams,
},
MaxMint {
vault: NameOrAddress,
receiver: NameOrAddress,
block: Option<BlockId>,
rpc: RpcOpts,
},
PreviewMint {
vault: NameOrAddress,
shares: U256,
block: Option<BlockId>,
rpc: RpcOpts,
},
Mint {
vault: NameOrAddress,
shares: U256,
receiver: NameOrAddress,
send_tx: SendTxOpts,
tx: TxParams,
},
MaxWithdraw {
vault: NameOrAddress,
owner: NameOrAddress,
block: Option<BlockId>,
rpc: RpcOpts,
},
PreviewWithdraw {
vault: NameOrAddress,
assets: U256,
block: Option<BlockId>,
rpc: RpcOpts,
},
Withdraw {
vault: NameOrAddress,
assets: U256,
receiver: NameOrAddress,
owner: NameOrAddress,
send_tx: SendTxOpts,
tx: TxParams,
},
MaxRedeem {
vault: NameOrAddress,
owner: NameOrAddress,
block: Option<BlockId>,
rpc: RpcOpts,
},
PreviewRedeem {
vault: NameOrAddress,
shares: U256,
block: Option<BlockId>,
rpc: RpcOpts,
},
Redeem {
vault: NameOrAddress,
shares: U256,
receiver: NameOrAddress,
owner: NameOrAddress,
send_tx: SendTxOpts,
tx: TxParams,
},
}Expand description
Interact with synchronous ERC-4626 tokenized vaults.
Variants§
Info
Show vault, asset, and exchange-rate information
Example:
$ cast erc4626 info 0xBEEF01735c132Ada46AA9aA4c54623cAA92A64CB --human \
--block 25519075 --rpc-url https://ethereum.reth.rs/rpcOutput:
Vault 0xBEEF01735c132Ada46AA9aA4c54623cAA92A64CB
Name Steakhouse USDC
Symbol steakUSDC
Decimals 18
Asset 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48
Asset name USD Coin
Asset symbol USDC
Asset decimals 6
Total assets 95183395.377893 USDC
Total supply 84037200.060143388288943211 steakUSDC
Assets per share 1.132634 USDC
Shares per asset 0.882897731163608580 steakUSDCFields
vault: NameOrAddressThe ERC-4626 vault contract address.
Position
Show an account’s shares, asset value, and withdrawal limits
Example:
$ cast erc4626 position 0xBEEF01735c132Ada46AA9aA4c54623cAA92A64CB \
0x255c7705E8bb334dfCaE438197f7c4297988085A --human --block 25519075 \
--rpc-url https://ethereum.reth.rs/rpcOutput:
Vault 0xBEEF01735c132Ada46AA9aA4c54623cAA92A64CB
Owner 0x255c7705e8BB334DfCae438197f7C4297988085a
Asset 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48
Share symbol steakUSDC
Share decimals 18
Asset symbol USDC
Asset decimals 6
Share balance 35733.949295544029939485 steakUSDC
Assets equivalent 40473.486378 USDC
Max withdraw 40473.486378 USDC
Max redeem 35733.949295417417957447 steakUSDCFields
vault: NameOrAddressThe ERC-4626 vault contract address.
owner: NameOrAddressThe owner of the vault shares.
Check
Probe synchronous ERC-4626 interface compatibility
Example:
$ cast erc4626 check 0xBEEF01735c132Ada46AA9aA4c54623cAA92A64CB \
--account 0x255c7705E8bb334dfCaE438197f7c4297988085A --block 25519075 \
--rpc-url https://ethereum.reth.rs/rpcOutput:
Vault 0xBEEF01735c132Ada46AA9aA4c54623cAA92A64CB
Account 0x255c7705e8BB334DfCae438197f7C4297988085a
Note: This probes read-call behavior only; it does not prove state-changing selector coverage or semantic ERC-4626 compliance.
PASS contract code contract bytecode is present
PASS asset() returned 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48
PASS asset contract underlying asset bytecode is present
PASS asset balanceOf(address) call succeeded
PASS totalAssets() call succeeded
PASS totalSupply() call succeeded
PASS balanceOf(address) call succeeded
PASS allowance(address,address) call succeeded
PASS convertToShares(0) returned zero
PASS convertToAssets(0) returned zero
PASS maxDeposit(address) call succeeded
PASS previewDeposit(0) returned zero
PASS maxMint(address) call succeeded
PASS previewMint(0) returned zero
PASS maxWithdraw(address) call succeeded
PASS previewWithdraw(0) returned zero
PASS maxRedeem(address) call succeeded
PASS previewRedeem(0) returned zero
PASS name() call succeeded
PASS symbol() call succeeded
PASS decimals() call succeeded
Summary: 21 passed, 0 warnings, 0 failedFields
vault: NameOrAddressThe ERC-4626 vault contract address.
Asset
Query the vault’s underlying asset token
Example:
$ cast erc4626 asset 0xBEEF01735c132Ada46AA9aA4c54623cAA92A64CB \
--block 25519075 --rpc-url https://ethereum.reth.rs/rpcOutput:
0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48Fields
vault: NameOrAddressThe ERC-4626 vault contract address.
TotalAssets
Query the total amount of underlying assets managed by the vault
Example:
$ cast erc4626 total-assets 0xBEEF01735c132Ada46AA9aA4c54623cAA92A64CB \
--block 25519075 --rpc-url https://ethereum.reth.rs/rpcOutput:
95183395377893 [9.518e13]Fields
vault: NameOrAddressThe ERC-4626 vault contract address.
Convert an asset amount to the corresponding share amount
Example:
$ cast erc4626 convert-to-shares 0xBEEF01735c132Ada46AA9aA4c54623cAA92A64CB \
1000000 --block 25519075 --rpc-url https://ethereum.reth.rs/rpcOutput:
882897731163608580 [8.828e17]ConvertToAssets
Convert a share amount to the corresponding asset amount
Example:
$ cast erc4626 convert-to-assets 0xBEEF01735c132Ada46AA9aA4c54623cAA92A64CB \
1000000000000000000 --block 25519075 \
--rpc-url https://ethereum.reth.rs/rpcOutput:
1132634 [1.132e6]MaxDeposit
Query the maximum assets that may be deposited for a receiver
Example:
$ cast erc4626 max-deposit 0xBEEF01735c132Ada46AA9aA4c54623cAA92A64CB \
0x255c7705E8bb334dfCaE438197f7c4297988085A --block 25519075 \
--rpc-url https://ethereum.reth.rs/rpcOutput:
1002934816604622098 [1.002e18]Fields
vault: NameOrAddressThe ERC-4626 vault contract address.
receiver: NameOrAddressThe receiver of the resulting vault shares.
PreviewDeposit
Preview the shares received by depositing an asset amount
Example:
$ cast erc4626 preview-deposit 0xBEEF01735c132Ada46AA9aA4c54623cAA92A64CB \
1000000 --block 25519075 --rpc-url https://ethereum.reth.rs/rpcOutput:
882897731163608580 [8.828e17]Fields
vault: NameOrAddressThe ERC-4626 vault contract address.
Deposit
Deposit assets into the vault
The vault must have sufficient allowance to spend the underlying asset.
Example:
$ cast erc4626 deposit 0xBEEF01735c132Ada46AA9aA4c54623cAA92A64CB \
1000000 $ACCOUNT --private-key $PRIVATE_KEY --async --rpc-url $ETH_RPC_URLOutput:
0x6f2a7e10f148a0ee81208cd8d7dee10cc33b5bdb739bfeef805dc68467e6db4eFields
vault: NameOrAddressThe ERC-4626 vault contract address.
receiver: NameOrAddressThe receiver of the resulting vault shares.
send_tx: SendTxOptsMaxMint
Query the maximum shares that may be minted for a receiver
Example:
$ cast erc4626 max-mint 0xBEEF01735c132Ada46AA9aA4c54623cAA92A64CB \
0x255c7705E8bb334dfCaE438197f7c4297988085A --block 25519075 \
--rpc-url https://ethereum.reth.rs/rpcOutput:
885488874085210715750045480687 [8.854e29]Fields
vault: NameOrAddressThe ERC-4626 vault contract address.
receiver: NameOrAddressThe receiver of the resulting vault shares.
PreviewMint
Preview the assets required to mint a share amount
Example:
$ cast erc4626 preview-mint 0xBEEF01735c132Ada46AA9aA4c54623cAA92A64CB \
1000000000000000000 --block 25519075 \
--rpc-url https://ethereum.reth.rs/rpcOutput:
1132635 [1.132e6]Mint
Mint vault shares
The vault must have sufficient allowance to spend the underlying asset.
Example:
$ cast erc4626 mint 0xBEEF01735c132Ada46AA9aA4c54623cAA92A64CB \
1000000000000000000 $ACCOUNT --private-key $PRIVATE_KEY --async \
--rpc-url $ETH_RPC_URLOutput:
0xa7c3b4e26a99e2cb422e2b36cffeae642a39f1d09f8f3454c9c2d4657ebb0491Fields
vault: NameOrAddressThe ERC-4626 vault contract address.
The amount of vault shares.
receiver: NameOrAddressThe receiver of the resulting vault shares.
send_tx: SendTxOptsMaxWithdraw
Query the maximum assets that an owner may withdraw
Example:
$ cast erc4626 max-withdraw 0xBEEF01735c132Ada46AA9aA4c54623cAA92A64CB \
0x255c7705E8bb334dfCaE438197f7c4297988085A --block 25519075 \
--rpc-url https://ethereum.reth.rs/rpcOutput:
40473486378 [4.047e10]Fields
vault: NameOrAddressThe ERC-4626 vault contract address.
owner: NameOrAddressThe owner of the vault shares.
PreviewWithdraw
Preview the shares burned to withdraw an asset amount
Example:
$ cast erc4626 preview-withdraw 0xBEEF01735c132Ada46AA9aA4c54623cAA92A64CB \
1000000 --block 25519075 --rpc-url https://ethereum.reth.rs/rpcOutput:
882897731163608581 [8.828e17]Fields
vault: NameOrAddressThe ERC-4626 vault contract address.
Withdraw
Withdraw assets from the vault
Example:
$ cast erc4626 withdraw 0xBEEF01735c132Ada46AA9aA4c54623cAA92A64CB \
1000000 $ACCOUNT $ACCOUNT --private-key $PRIVATE_KEY --async \
--rpc-url $ETH_RPC_URLOutput:
0x6d6d70151151f30aa13bdb4082ea7fd3e531193eebdfbb356586284cd0e6a8a2Fields
vault: NameOrAddressThe ERC-4626 vault contract address.
receiver: NameOrAddressThe receiver of the withdrawn assets.
owner: NameOrAddressThe owner of the vault shares.
send_tx: SendTxOptsMaxRedeem
Query the maximum shares that an owner may redeem
Example:
$ cast erc4626 max-redeem 0xBEEF01735c132Ada46AA9aA4c54623cAA92A64CB \
0x255c7705E8bb334dfCaE438197f7c4297988085A --block 25519075 \
--rpc-url https://ethereum.reth.rs/rpcOutput:
35733949295417417957447 [3.573e22]Fields
vault: NameOrAddressThe ERC-4626 vault contract address.
owner: NameOrAddressThe owner of the vault shares.
PreviewRedeem
Preview the assets received by redeeming a share amount
Example:
$ cast erc4626 preview-redeem 0xBEEF01735c132Ada46AA9aA4c54623cAA92A64CB \
1000000000000000000 --block 25519075 \
--rpc-url https://ethereum.reth.rs/rpcOutput:
1132634 [1.132e6]Redeem
Redeem vault shares for assets
Example:
$ cast erc4626 redeem 0xBEEF01735c132Ada46AA9aA4c54623cAA92A64CB \
1000000000000000000 $ACCOUNT $ACCOUNT --private-key $PRIVATE_KEY --async \
--rpc-url $ETH_RPC_URLOutput:
0x304d463e4d33b462778a974d008cd1b9c4c109730ae6617d2815477b8aa7c03eImplementations§
Trait Implementations§
Source§impl Clone for Erc4626Subcommand
impl Clone for Erc4626Subcommand
Source§fn clone(&self) -> Erc4626Subcommand
fn clone(&self) -> Erc4626Subcommand
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl CommandFactory for Erc4626Subcommand
impl CommandFactory for Erc4626Subcommand
Source§impl Debug for Erc4626Subcommand
impl Debug for Erc4626Subcommand
Source§impl FromArgMatches for Erc4626Subcommand
impl FromArgMatches for Erc4626Subcommand
Source§fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>
fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>
Source§fn from_arg_matches_mut(
__clap_arg_matches: &mut ArgMatches,
) -> Result<Self, Error>
fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>
Source§fn update_from_arg_matches(
&mut self,
__clap_arg_matches: &ArgMatches,
) -> Result<(), Error>
fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>
ArgMatches to self.Source§fn update_from_arg_matches_mut<'b>(
&mut self,
__clap_arg_matches: &mut ArgMatches,
) -> Result<(), Error>
fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>
ArgMatches to self.Source§impl Parser for Erc4626Subcommand
impl Parser for Erc4626Subcommand
§fn parse_from<I, T>(itr: I) -> Self
fn parse_from<I, T>(itr: I) -> Self
§fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>
fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>
§fn update_from<I, T>(&mut self, itr: I)
fn update_from<I, T>(&mut self, itr: I)
§fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>
fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>
Source§impl Subcommand for Erc4626Subcommand
impl Subcommand for Erc4626Subcommand
Source§fn augment_subcommands<'b>(__clap_app: Command) -> Command
fn augment_subcommands<'b>(__clap_app: Command) -> Command
Source§fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command
fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command
Command] so it can instantiate self via
[FromArgMatches::update_from_arg_matches_mut] Read moreSource§fn has_subcommand(__clap_name: &str) -> bool
fn has_subcommand(__clap_name: &str) -> bool
Self can parse a specific subcommandAuto Trait Implementations§
impl Freeze for Erc4626Subcommand
impl RefUnwindSafe for Erc4626Subcommand
impl Send for Erc4626Subcommand
impl Sync for Erc4626Subcommand
impl Unpin for Erc4626Subcommand
impl UnsafeUnpin for Erc4626Subcommand
impl UnwindSafe for Erc4626Subcommand
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T, R> CollectAndApply<T, R> for T
impl<T, R> CollectAndApply<T, R> for T
§impl<T> Conv for T
impl<T> Conv for T
impl<T> ErasedDestructor for Twhere
T: 'static,
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<TxEnv, T> FromRecoveredTx<&T> for TxEnvwhere
TxEnv: FromRecoveredTx<T>,
impl<TxEnv, T> FromRecoveredTx<&T> for TxEnvwhere
TxEnv: FromRecoveredTx<T>,
§fn from_recovered_tx(tx: &&T, sender: Address) -> TxEnv
fn from_recovered_tx(tx: &&T, sender: Address) -> TxEnv
TxEnv from a transaction and a sender address.§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T in a tonic::Request§impl<L> LayerExt<L> for L
impl<L> LayerExt<L> for L
§fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>where
L: Layer<S>,
fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>where
L: Layer<S>,
Layered].impl<T> MaybeCompact for T
§impl<D> OwoColorize for D
impl<D> OwoColorize for D
§fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
§fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
§fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
§fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
§fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
§fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
§fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
§fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
§fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
§fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
§fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
§fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
§fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
§fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
§fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
§fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
§fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
§fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
§fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
§fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
§fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
§fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
§fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
§fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
§fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
§fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
OwoColorize::fg] or
a color-specific method, such as [OwoColorize::green], Read more§fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
OwoColorize::bg] or
a color-specific method, such as [OwoColorize::on_yellow], Read more§fn fg_rgb<const R: u8, const G: u8, const B: u8>(
&self,
) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>
fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>
§fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&self,
) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>
fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>
§fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>
fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>
§fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>
fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>
§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§fn fg(&self, value: Color) -> Painted<&T>
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 bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§fn bg(&self, value: Color) -> Painted<&T>
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>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§fn attr(&self, value: Attribute) -> Painted<&T>
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 rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§fn quirk(&self, value: Quirk) -> Painted<&T>
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 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.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
§fn whenever(&self, value: Condition) -> Painted<&T>
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);§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
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) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
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
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
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
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
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
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.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
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.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
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.§impl<T> Threaded<T> for T
impl<T> Threaded<T> for T
§impl<T> TryConv for T
impl<T> TryConv for T
§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘwhere
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘwhere
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ
fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ
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: 1112 bytes
Size for each variant:
Info: 199 bytesPosition: 231 bytesCheck: 231 bytesAsset: 199 bytesTotalAssets: 199 bytesConvertToShares: 231 bytesConvertToAssets: 231 bytesMaxDeposit: 231 bytesPreviewDeposit: 231 bytesDeposit: 1079 bytesMaxMint: 231 bytesPreviewMint: 231 bytesMint: 1079 bytesMaxWithdraw: 231 bytesPreviewWithdraw: 231 bytesWithdraw: 1111 bytesMaxRedeem: 231 bytesPreviewRedeem: 231 bytesRedeem: 1111 bytes