#[non_exhaustive]pub struct CreateThemeDataBuilder { /* private fields */ }Expand description
A builder for CreateThemeData.
Implementations§
Source§impl CreateThemeDataBuilder
impl CreateThemeDataBuilder
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the theme.
This field is required.Sourcepub fn values(self, input: ThemeValues) -> Self
pub fn values(self, input: ThemeValues) -> Self
Appends an item to values.
To override the contents of this collection use set_values.
A list of key-value pairs that defines the properties of the theme.
Sourcepub fn set_values(self, input: Option<Vec<ThemeValues>>) -> Self
pub fn set_values(self, input: Option<Vec<ThemeValues>>) -> Self
A list of key-value pairs that defines the properties of the theme.
Sourcepub fn get_values(&self) -> &Option<Vec<ThemeValues>>
pub fn get_values(&self) -> &Option<Vec<ThemeValues>>
A list of key-value pairs that defines the properties of the theme.
Sourcepub fn overrides(self, input: ThemeValues) -> Self
pub fn overrides(self, input: ThemeValues) -> Self
Appends an item to overrides.
To override the contents of this collection use set_overrides.
Describes the properties that can be overriden to customize an instance of the theme.
Sourcepub fn set_overrides(self, input: Option<Vec<ThemeValues>>) -> Self
pub fn set_overrides(self, input: Option<Vec<ThemeValues>>) -> Self
Describes the properties that can be overriden to customize an instance of the theme.
Sourcepub fn get_overrides(&self) -> &Option<Vec<ThemeValues>>
pub fn get_overrides(&self) -> &Option<Vec<ThemeValues>>
Describes the properties that can be overriden to customize an instance of the theme.
Adds a key-value pair to tags.
To override the contents of this collection use set_tags.
One or more key-value pairs to use when tagging the theme data.
One or more key-value pairs to use when tagging the theme data.
One or more key-value pairs to use when tagging the theme data.
Sourcepub fn build(self) -> Result<CreateThemeData, BuildError>
pub fn build(self) -> Result<CreateThemeData, BuildError>
Consumes the builder and constructs a CreateThemeData.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for CreateThemeDataBuilder
impl Clone for CreateThemeDataBuilder
Source§fn clone(&self) -> CreateThemeDataBuilder
fn clone(&self) -> CreateThemeDataBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for CreateThemeDataBuilder
impl Debug for CreateThemeDataBuilder
Source§impl Default for CreateThemeDataBuilder
impl Default for CreateThemeDataBuilder
Source§fn default() -> CreateThemeDataBuilder
fn default() -> CreateThemeDataBuilder
Source§impl PartialEq for CreateThemeDataBuilder
impl PartialEq for CreateThemeDataBuilder
impl StructuralPartialEq for CreateThemeDataBuilder
Auto Trait Implementations§
impl Freeze for CreateThemeDataBuilder
impl RefUnwindSafe for CreateThemeDataBuilder
impl Send for CreateThemeDataBuilder
impl Sync for CreateThemeDataBuilder
impl Unpin for CreateThemeDataBuilder
impl UnwindSafe for CreateThemeDataBuilder
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> 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> 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>
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);