pub struct NonFungibleFaucet { /* private fields */ }Expand description
An AccountComponent implementing a non-fungible (NFT) faucet.
The asset value is an opaque word chosen by the caller. By convention the minter sets it to the
off-chain commitment compute_asset_commitment produces, but the faucet validates neither
that construction nor knowledge of a preimage - see that method’s documentation.
The NFT’s token ID is (hash0, hash1) - the asset class the protocol derives from the value’s
first two elements, which uniquely identifies each NFT within the faucet. The one property
enforced on-chain is token ID uniqueness, via an asset-status registry keyed by
[hash0, hash1, 0, 0]: a token ID can be issued at most once, and once burned it is permanently
consumed. Which values may be issued is decided entirely by the active mint policy, which
receives the full asset value; a permissive policy such as allow_all lets any caller claim any
token ID.
It re-exports the procedures from miden::standards::faucets::non_fungible plus the shared
token metadata accessors. The procedures are:
mint_and_send, which mints an NFT for a commitment and creates a note for the recipient.receive_and_burn, which receives the NFT from the active note and burns it.get_symbol,get_asset_status, and the metadata accessors/setters (see the embeddedTokenMetadata).
mint_and_send is gated by the active mint policy from the associated TokenPolicyManager;
receive_and_burn is gated by the active burn policy.
Implementations§
Source§impl NonFungibleFaucet
impl NonFungibleFaucet
Sourcepub fn builder() -> NonFungibleFaucetBuilder
pub fn builder() -> NonFungibleFaucetBuilder
Returns a builder for NonFungibleFaucet.
Required setters: name, symbol. Optional string fields default to None;
mutability flags default to false. The collection metadata pointer is named
contract_uri (it reuses the shared external_link storage).
Source§impl NonFungibleFaucet
impl NonFungibleFaucet
Sourcepub const NAME: &'static str = "miden::standards::faucets::non_fungible"
pub const NAME: &'static str = "miden::standards::faucets::non_fungible"
The name of the component.
Sourcepub const fn name() -> AccountComponentName
pub const fn name() -> AccountComponentName
Returns the canonical AccountComponentName of this component.
Sourcepub fn code() -> &'static AccountComponentCode
pub fn code() -> &'static AccountComponentCode
Returns the AccountComponentCode of this component.
Sourcepub fn mint_and_send_root() -> AccountProcedureRoot
pub fn mint_and_send_root() -> AccountProcedureRoot
Returns the procedure root of the mint_and_send account procedure.
Sourcepub fn receive_and_burn_root() -> AccountProcedureRoot
pub fn receive_and_burn_root() -> AccountProcedureRoot
Returns the procedure root of the receive_and_burn account procedure.
Sourcepub fn set_description_root() -> AccountProcedureRoot
pub fn set_description_root() -> AccountProcedureRoot
Returns the procedure root of the set_description account procedure. Authority-gated.
Sourcepub fn set_logo_uri_root() -> AccountProcedureRoot
pub fn set_logo_uri_root() -> AccountProcedureRoot
Returns the procedure root of the set_logo_uri account procedure. Authority-gated.
Sourcepub fn set_contract_uri_root() -> AccountProcedureRoot
pub fn set_contract_uri_root() -> AccountProcedureRoot
Returns the procedure root of the set_contract_uri account procedure. Authority-gated.
Sourcepub fn symbol_slot() -> &'static StorageSlotName
pub fn symbol_slot() -> &'static StorageSlotName
Returns the StorageSlotName holding the token symbol word.
Sourcepub fn asset_status_slot() -> &'static StorageSlotName
pub fn asset_status_slot() -> &'static StorageSlotName
Returns the StorageSlotName holding the asset-status registry map.
Sourcepub fn symbol(&self) -> &TokenSymbol
pub fn symbol(&self) -> &TokenSymbol
Returns the token symbol.
Sourcepub fn token_name(&self) -> &TokenName
pub fn token_name(&self) -> &TokenName
Returns the token name.
Sourcepub fn description(&self) -> Option<&Description>
pub fn description(&self) -> Option<&Description>
Returns the optional description.
Sourcepub fn contract_uri(&self) -> Option<&ExternalLink>
pub fn contract_uri(&self) -> Option<&ExternalLink>
Returns the optional collection metadata pointer (contract_uri, stored in the shared
external_link slot).
Sourcepub fn compute_asset_commitment(user_data: &[u8], salt: Word) -> Word
pub fn compute_asset_commitment(user_data: &[u8], salt: Word) -> Word
Computes the off-chain asset commitment hash(user_data, salt) that the minter is expected
to use as the NFT asset value.
This must be computed off-chain: computing it on-chain would leak the salt and make the
underlying user_data invertible. The faucet never sees user_data or salt — only
this commitment word.
Using this helper is a convention, not an enforced property. mint_and_send accepts any
word: it cannot check that a value is a hash output, that a salt was used, or that the
minter knows a preimage. Consequently a minted asset value attests to nothing the faucet
verified. Integrators that rely on the value identifying specific off-chain data must
recompute the commitment from the user_data and salt they received and compare it to
the on-chain asset value themselves. Where issuance itself must be controlled - e.g. so a
published commitment cannot be claimed by a third party - install a restrictive mint policy
such as owner_only rather than allow_all; the policy hook receives the full asset value.
Sourcepub fn get_asset_status(
storage: &AccountStorage,
asset_commitment: Word,
) -> Result<AssetStatus, NonFungibleFaucetError>
pub fn get_asset_status( storage: &AccountStorage, asset_commitment: Word, ) -> Result<AssetStatus, NonFungibleFaucetError>
Reads the issuance AssetStatus of the token ID derived from asset_commitment (the
asset value, by convention produced by compute_asset_commitment) from the faucet
account’s storage.
The status is keyed by the token ID - elements 0 and 1 of the value - so two values that differ only in elements 2 and 3 share a single status entry.
§Errors
Returns an error if the asset-status slot cannot be read or holds an invalid status code.
Sourcepub fn symbol_slot_schema() -> (StorageSlotName, StorageSlotSchema)
pub fn symbol_slot_schema() -> (StorageSlotName, StorageSlotSchema)
Returns the storage slot schema for the token symbol slot.
Sourcepub fn asset_status_slot_schema() -> (StorageSlotName, StorageSlotSchema)
pub fn asset_status_slot_schema() -> (StorageSlotName, StorageSlotSchema)
Returns the storage slot schema for the asset-status registry map.
Sourcepub fn component_metadata() -> AccountComponentMetadata
pub fn component_metadata() -> AccountComponentMetadata
Returns the AccountComponentMetadata for this component.
Sourcepub fn into_storage_slots(self) -> Vec<StorageSlot>
pub fn into_storage_slots(self) -> Vec<StorageSlot>
Returns the storage slots produced by this faucet (token symbol word + empty asset-status map + name + mutability config + description + logo URI + contract URI).
Sourcepub fn symbol_slot_value(&self) -> StorageSlot
pub fn symbol_slot_value(&self) -> StorageSlot
Returns the single storage slot for the token symbol word.
Trait Implementations§
Source§impl Clone for NonFungibleFaucet
impl Clone for NonFungibleFaucet
Source§fn clone(&self) -> NonFungibleFaucet
fn clone(&self) -> NonFungibleFaucet
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for NonFungibleFaucet
impl Debug for NonFungibleFaucet
Source§impl From<NonFungibleFaucet> for AccountComponent
impl From<NonFungibleFaucet> for AccountComponent
Source§fn from(faucet: NonFungibleFaucet) -> AccountComponent
fn from(faucet: NonFungibleFaucet) -> AccountComponent
Source§impl TryFrom<&Account> for NonFungibleFaucet
impl TryFrom<&Account> for NonFungibleFaucet
Source§type Error = NonFungibleFaucetError
type Error = NonFungibleFaucetError
Source§fn try_from(
account: &Account,
) -> Result<NonFungibleFaucet, <NonFungibleFaucet as TryFrom<&Account>>::Error>
fn try_from( account: &Account, ) -> Result<NonFungibleFaucet, <NonFungibleFaucet as TryFrom<&Account>>::Error>
Source§impl TryFrom<&AccountStorage> for NonFungibleFaucet
impl TryFrom<&AccountStorage> for NonFungibleFaucet
Source§type Error = NonFungibleFaucetError
type Error = NonFungibleFaucetError
Source§fn try_from(
storage: &AccountStorage,
) -> Result<NonFungibleFaucet, <NonFungibleFaucet as TryFrom<&AccountStorage>>::Error>
fn try_from( storage: &AccountStorage, ) -> Result<NonFungibleFaucet, <NonFungibleFaucet as TryFrom<&AccountStorage>>::Error>
Auto Trait Implementations§
impl Freeze for NonFungibleFaucet
impl RefUnwindSafe for NonFungibleFaucet
impl Send for NonFungibleFaucet
impl Sync for NonFungibleFaucet
impl Unpin for NonFungibleFaucet
impl UnsafeUnpin for NonFungibleFaucet
impl UnwindSafe for NonFungibleFaucet
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,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> 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 moreSource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T in a tonic::RequestSource§impl<D> OwoColorize for D
impl<D> OwoColorize for D
Source§fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
Source§fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
Source§fn black(&self) -> FgColorDisplay<'_, Black, Self>
fn black(&self) -> FgColorDisplay<'_, Black, Self>
Source§fn on_black(&self) -> BgColorDisplay<'_, Black, Self>
fn on_black(&self) -> BgColorDisplay<'_, Black, Self>
Source§fn red(&self) -> FgColorDisplay<'_, Red, Self>
fn red(&self) -> FgColorDisplay<'_, Red, Self>
Source§fn on_red(&self) -> BgColorDisplay<'_, Red, Self>
fn on_red(&self) -> BgColorDisplay<'_, Red, Self>
Source§fn green(&self) -> FgColorDisplay<'_, Green, Self>
fn green(&self) -> FgColorDisplay<'_, Green, Self>
Source§fn on_green(&self) -> BgColorDisplay<'_, Green, Self>
fn on_green(&self) -> BgColorDisplay<'_, Green, Self>
Source§fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>
fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>
Source§fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>
fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>
Source§fn blue(&self) -> FgColorDisplay<'_, Blue, Self>
fn blue(&self) -> FgColorDisplay<'_, Blue, Self>
Source§fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>
fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>
Source§fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>
fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>
Source§fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
Source§fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>
fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>
Source§fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>
fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>
Source§fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>
fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>
Source§fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>
fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>
Source§fn white(&self) -> FgColorDisplay<'_, White, Self>
fn white(&self) -> FgColorDisplay<'_, White, Self>
Source§fn on_white(&self) -> BgColorDisplay<'_, White, Self>
fn on_white(&self) -> BgColorDisplay<'_, White, Self>
Source§fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
Source§fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
Source§fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
Source§fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
Source§fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
Source§fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
Source§fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
Source§fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
Source§fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
Source§fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
Source§fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
Source§fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
Source§fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
Source§fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
Source§fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
Source§fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
Source§fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
Source§fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
Source§fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
Source§fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
Source§fn bold(&self) -> BoldDisplay<'_, Self>
fn bold(&self) -> BoldDisplay<'_, Self>
Source§fn dimmed(&self) -> DimDisplay<'_, Self>
fn dimmed(&self) -> DimDisplay<'_, Self>
Source§fn italic(&self) -> ItalicDisplay<'_, Self>
fn italic(&self) -> ItalicDisplay<'_, Self>
Source§fn underline(&self) -> UnderlineDisplay<'_, Self>
fn underline(&self) -> UnderlineDisplay<'_, Self>
Source§fn blink(&self) -> BlinkDisplay<'_, Self>
fn blink(&self) -> BlinkDisplay<'_, Self>
Source§fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
Source§fn reversed(&self) -> ReversedDisplay<'_, Self>
fn reversed(&self) -> ReversedDisplay<'_, Self>
Source§fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
Source§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 moreSource§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 moreSource§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>
Source§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>
Source§fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>
fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>
Source§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>
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§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();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§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();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§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();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§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();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§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);