pub struct ToolMetadataBuilder<S: State = Empty> { /* private fields */ }Expand description
Use builder syntax to set the inputs and finish with build().
Implementations§
Source§impl<S: State> ToolMetadataBuilder<S>
impl<S: State> ToolMetadataBuilder<S>
Sourcepub fn build(self) -> ToolMetadatawhere
S: IsComplete,
pub fn build(self) -> ToolMetadatawhere
S: IsComplete,
Finish building and return the requested object
Sourcepub fn name(self, value: impl Into<String>) -> ToolMetadataBuilder<SetName<S>>where
S::Name: IsUnset,
pub fn name(self, value: impl Into<String>) -> ToolMetadataBuilder<SetName<S>>where
S::Name: IsUnset,
Required.
Human- and machine-facing tool name (mytool).
Sourcepub fn summary(
self,
value: impl Into<String>,
) -> ToolMetadataBuilder<SetSummary<S>>where
S::Summary: IsUnset,
pub fn summary(
self,
value: impl Into<String>,
) -> ToolMetadataBuilder<SetSummary<S>>where
S::Summary: IsUnset,
Required.
One-line summary used in --help and the CLI banner.
Sourcepub fn description(
self,
value: impl Into<String>,
) -> ToolMetadataBuilder<SetDescription<S>>where
S::Description: IsUnset,
pub fn description(
self,
value: impl Into<String>,
) -> ToolMetadataBuilder<SetDescription<S>>where
S::Description: IsUnset,
Sourcepub fn maybe_description(
self,
value: Option<impl Into<String>>,
) -> ToolMetadataBuilder<SetDescription<S>>where
S::Description: IsUnset,
pub fn maybe_description(
self,
value: Option<impl Into<String>>,
) -> ToolMetadataBuilder<SetDescription<S>>where
S::Description: IsUnset,
Sourcepub fn release_source(
self,
value: ReleaseSource,
) -> ToolMetadataBuilder<SetReleaseSource<S>>where
S::ReleaseSource: IsUnset,
pub fn release_source(
self,
value: ReleaseSource,
) -> ToolMetadataBuilder<SetReleaseSource<S>>where
S::ReleaseSource: IsUnset,
Sourcepub fn maybe_release_source(
self,
value: Option<ReleaseSource>,
) -> ToolMetadataBuilder<SetReleaseSource<S>>where
S::ReleaseSource: IsUnset,
pub fn maybe_release_source(
self,
value: Option<ReleaseSource>,
) -> ToolMetadataBuilder<SetReleaseSource<S>>where
S::ReleaseSource: IsUnset,
Sourcepub fn update_policy(
self,
value: UpdatePolicy,
) -> ToolMetadataBuilder<SetUpdatePolicy<S>>where
S::UpdatePolicy: IsUnset,
pub fn update_policy(
self,
value: UpdatePolicy,
) -> ToolMetadataBuilder<SetUpdatePolicy<S>>where
S::UpdatePolicy: IsUnset,
Optional (Some / Option setters).
Default: <UpdatePolicy as Default>::default().
Author-set self-update policy baseline. Default
UpdatePolicy::Disabled. In v0.1 the effective policy is this
baseline (a runtime config override is deferred — see the spec).
Inert unless Feature::Update is enabled and release_source is
set.
Sourcepub fn maybe_update_policy(
self,
value: Option<UpdatePolicy>,
) -> ToolMetadataBuilder<SetUpdatePolicy<S>>where
S::UpdatePolicy: IsUnset,
pub fn maybe_update_policy(
self,
value: Option<UpdatePolicy>,
) -> ToolMetadataBuilder<SetUpdatePolicy<S>>where
S::UpdatePolicy: IsUnset,
Optional (Some / Option setters).
Default: <UpdatePolicy as Default>::default().
Author-set self-update policy baseline. Default
UpdatePolicy::Disabled. In v0.1 the effective policy is this
baseline (a runtime config override is deferred — see the spec).
Inert unless Feature::Update is enabled and release_source is
set.
Sourcepub fn update_check_interval(
self,
value: Duration,
) -> ToolMetadataBuilder<SetUpdateCheckInterval<S>>where
S::UpdateCheckInterval: IsUnset,
pub fn update_check_interval(
self,
value: Duration,
) -> ToolMetadataBuilder<SetUpdateCheckInterval<S>>where
S::UpdateCheckInterval: IsUnset,
Sourcepub fn maybe_update_check_interval(
self,
value: Option<Duration>,
) -> ToolMetadataBuilder<SetUpdateCheckInterval<S>>where
S::UpdateCheckInterval: IsUnset,
pub fn maybe_update_check_interval(
self,
value: Option<Duration>,
) -> ToolMetadataBuilder<SetUpdateCheckInterval<S>>where
S::UpdateCheckInterval: IsUnset,
Sourcepub fn release_credential(
self,
value: CredentialRef,
) -> ToolMetadataBuilder<SetReleaseCredential<S>>where
S::ReleaseCredential: IsUnset,
pub fn release_credential(
self,
value: CredentialRef,
) -> ToolMetadataBuilder<SetReleaseCredential<S>>where
S::ReleaseCredential: IsUnset,
Optional (Some / Option setters).
Optional credential reference for the release source. Resolved
at update time via rtb_credentials::Resolver. Public repos
don’t need it; private repos require this OR a fallback env
var the resolver knows about.
Deserialised from config files but never serialised back —
CredentialRef contains a SecretString literal that should
not round-trip through Serialize (the secrecy crate
removed the Serialize impl on purpose, mirroring the
“secrets don’t cross untyped boundaries” rule).
Sourcepub fn maybe_release_credential(
self,
value: Option<CredentialRef>,
) -> ToolMetadataBuilder<SetReleaseCredential<S>>where
S::ReleaseCredential: IsUnset,
pub fn maybe_release_credential(
self,
value: Option<CredentialRef>,
) -> ToolMetadataBuilder<SetReleaseCredential<S>>where
S::ReleaseCredential: IsUnset,
Optional (Some / Option setters).
Optional credential reference for the release source. Resolved
at update time via rtb_credentials::Resolver. Public repos
don’t need it; private repos require this OR a fallback env
var the resolver knows about.
Deserialised from config files but never serialised back —
CredentialRef contains a SecretString literal that should
not round-trip through Serialize (the secrecy crate
removed the Serialize impl on purpose, mirroring the
“secrets don’t cross untyped boundaries” rule).
Sourcepub fn help(self, value: HelpChannel) -> ToolMetadataBuilder<SetHelp<S>>where
S::Help: IsUnset,
pub fn help(self, value: HelpChannel) -> ToolMetadataBuilder<SetHelp<S>>where
S::Help: IsUnset,
Sourcepub fn maybe_help(
self,
value: Option<HelpChannel>,
) -> ToolMetadataBuilder<SetHelp<S>>where
S::Help: IsUnset,
pub fn maybe_help(
self,
value: Option<HelpChannel>,
) -> ToolMetadataBuilder<SetHelp<S>>where
S::Help: IsUnset,
Sourcepub fn update_public_keys(
self,
value: Vec<String>,
) -> ToolMetadataBuilder<SetUpdatePublicKeys<S>>where
S::UpdatePublicKeys: IsUnset,
pub fn update_public_keys(
self,
value: Vec<String>,
) -> ToolMetadataBuilder<SetUpdatePublicKeys<S>>where
S::UpdatePublicKeys: IsUnset,
Optional (Some / Option setters).
Default: <Vec<String> as Default>::default().
minisign public keys trusted for verifying release-asset
signatures, each the base64 string a minisign.pub file
carries — "RWR…", decoding to algorithm tag, key id and the
32-byte Ed25519 key.
This is deliberately the same string pinned as pubkey in a
crate’s [package.metadata.binstall.signing] table and printed
by sigillum keys minisign. One canonical representation means
cargo-binstall and rtb-update cannot end up trusting
different things, and an operator can compare the two by eye.
The key id matters: rtb-update verifies via the same
minisign-verify crate cargo-binstall uses, which matches a
signature’s key id against the public key’s before checking any
signature. A bare 32-byte key cannot satisfy that, which is why
this carries the full encoded form rather than raw key bytes.
Multiple keys enable rotation without breaking already-deployed
binaries — any one verifying is accepted, so a binary shipped
trusting {old, new} spans a rotation. Empty means
rtb-update refuses to run (see UpdateError::NoPublicKey).
Not serialised — keys are compile-time constants, not
config-file values.
Sourcepub fn maybe_update_public_keys(
self,
value: Option<Vec<String>>,
) -> ToolMetadataBuilder<SetUpdatePublicKeys<S>>where
S::UpdatePublicKeys: IsUnset,
pub fn maybe_update_public_keys(
self,
value: Option<Vec<String>>,
) -> ToolMetadataBuilder<SetUpdatePublicKeys<S>>where
S::UpdatePublicKeys: IsUnset,
Optional (Some / Option setters).
Default: <Vec<String> as Default>::default().
minisign public keys trusted for verifying release-asset
signatures, each the base64 string a minisign.pub file
carries — "RWR…", decoding to algorithm tag, key id and the
32-byte Ed25519 key.
This is deliberately the same string pinned as pubkey in a
crate’s [package.metadata.binstall.signing] table and printed
by sigillum keys minisign. One canonical representation means
cargo-binstall and rtb-update cannot end up trusting
different things, and an operator can compare the two by eye.
The key id matters: rtb-update verifies via the same
minisign-verify crate cargo-binstall uses, which matches a
signature’s key id against the public key’s before checking any
signature. A bare 32-byte key cannot satisfy that, which is why
this carries the full encoded form rather than raw key bytes.
Multiple keys enable rotation without breaking already-deployed
binaries — any one verifying is accepted, so a binary shipped
trusting {old, new} spans a rotation. Empty means
rtb-update refuses to run (see UpdateError::NoPublicKey).
Not serialised — keys are compile-time constants, not
config-file values.
Sourcepub fn update_checksums_asset(
self,
value: &'static str,
) -> ToolMetadataBuilder<SetUpdateChecksumsAsset<S>>where
S::UpdateChecksumsAsset: IsUnset,
pub fn update_checksums_asset(
self,
value: &'static str,
) -> ToolMetadataBuilder<SetUpdateChecksumsAsset<S>>where
S::UpdateChecksumsAsset: IsUnset,
Sourcepub fn maybe_update_checksums_asset(
self,
value: Option<&'static str>,
) -> ToolMetadataBuilder<SetUpdateChecksumsAsset<S>>where
S::UpdateChecksumsAsset: IsUnset,
pub fn maybe_update_checksums_asset(
self,
value: Option<&'static str>,
) -> ToolMetadataBuilder<SetUpdateChecksumsAsset<S>>where
S::UpdateChecksumsAsset: IsUnset,
Sourcepub fn update_asset_pattern(
self,
value: &'static str,
) -> ToolMetadataBuilder<SetUpdateAssetPattern<S>>where
S::UpdateAssetPattern: IsUnset,
pub fn update_asset_pattern(
self,
value: &'static str,
) -> ToolMetadataBuilder<SetUpdateAssetPattern<S>>where
S::UpdateAssetPattern: IsUnset,
Optional (Some / Option setters).
Asset-name template rtb-update uses to select the right
artefact for the running host. Default:
{name}-{version}-{target}{ext}. Placeholders:
{name} → ToolMetadata::name, {version} → release tag
(leading v stripped), {target} → Rust host triple,
{ext} → .tar.gz on Unix / .zip on Windows. Tools with
a different naming convention set this explicitly.
Sourcepub fn maybe_update_asset_pattern(
self,
value: Option<&'static str>,
) -> ToolMetadataBuilder<SetUpdateAssetPattern<S>>where
S::UpdateAssetPattern: IsUnset,
pub fn maybe_update_asset_pattern(
self,
value: Option<&'static str>,
) -> ToolMetadataBuilder<SetUpdateAssetPattern<S>>where
S::UpdateAssetPattern: IsUnset,
Optional (Some / Option setters).
Asset-name template rtb-update uses to select the right
artefact for the running host. Default:
{name}-{version}-{target}{ext}. Placeholders:
{name} → ToolMetadata::name, {version} → release tag
(leading v stripped), {target} → Rust host triple,
{ext} → .tar.gz on Unix / .zip on Windows. Tools with
a different naming convention set this explicitly.
Sourcepub fn telemetry_notice(
self,
value: &'static str,
) -> ToolMetadataBuilder<SetTelemetryNotice<S>>where
S::TelemetryNotice: IsUnset,
pub fn telemetry_notice(
self,
value: &'static str,
) -> ToolMetadataBuilder<SetTelemetryNotice<S>>where
S::TelemetryNotice: IsUnset,
Sourcepub fn maybe_telemetry_notice(
self,
value: Option<&'static str>,
) -> ToolMetadataBuilder<SetTelemetryNotice<S>>where
S::TelemetryNotice: IsUnset,
pub fn maybe_telemetry_notice(
self,
value: Option<&'static str>,
) -> ToolMetadataBuilder<SetTelemetryNotice<S>>where
S::TelemetryNotice: IsUnset,
Auto Trait Implementations§
impl<S> Freeze for ToolMetadataBuilder<S>
impl<S> RefUnwindSafe for ToolMetadataBuilder<S>
impl<S> Send for ToolMetadataBuilder<S>
impl<S> Sync for ToolMetadataBuilder<S>
impl<S> Unpin for ToolMetadataBuilder<S>
impl<S> UnsafeUnpin for ToolMetadataBuilder<S>
impl<S> UnwindSafe for ToolMetadataBuilder<S>
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
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<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);