#[non_exhaustive]pub struct ThemeConfigurationBuilder { /* private fields */ }
Expand description
A builder for ThemeConfiguration
.
Implementations§
Source§impl ThemeConfigurationBuilder
impl ThemeConfigurationBuilder
Sourcepub fn data_color_palette(self, input: DataColorPalette) -> Self
pub fn data_color_palette(self, input: DataColorPalette) -> Self
Color properties that apply to chart data colors.
Sourcepub fn set_data_color_palette(self, input: Option<DataColorPalette>) -> Self
pub fn set_data_color_palette(self, input: Option<DataColorPalette>) -> Self
Color properties that apply to chart data colors.
Sourcepub fn get_data_color_palette(&self) -> &Option<DataColorPalette>
pub fn get_data_color_palette(&self) -> &Option<DataColorPalette>
Color properties that apply to chart data colors.
Sourcepub fn ui_color_palette(self, input: UiColorPalette) -> Self
pub fn ui_color_palette(self, input: UiColorPalette) -> Self
Color properties that apply to the UI and to charts, excluding the colors that apply to data.
Sourcepub fn set_ui_color_palette(self, input: Option<UiColorPalette>) -> Self
pub fn set_ui_color_palette(self, input: Option<UiColorPalette>) -> Self
Color properties that apply to the UI and to charts, excluding the colors that apply to data.
Sourcepub fn get_ui_color_palette(&self) -> &Option<UiColorPalette>
pub fn get_ui_color_palette(&self) -> &Option<UiColorPalette>
Color properties that apply to the UI and to charts, excluding the colors that apply to data.
Sourcepub fn sheet(self, input: SheetStyle) -> Self
pub fn sheet(self, input: SheetStyle) -> Self
Display options related to sheets.
Sourcepub fn set_sheet(self, input: Option<SheetStyle>) -> Self
pub fn set_sheet(self, input: Option<SheetStyle>) -> Self
Display options related to sheets.
Sourcepub fn get_sheet(&self) -> &Option<SheetStyle>
pub fn get_sheet(&self) -> &Option<SheetStyle>
Display options related to sheets.
Sourcepub fn typography(self, input: Typography) -> Self
pub fn typography(self, input: Typography) -> Self
Determines the typography options.
Sourcepub fn set_typography(self, input: Option<Typography>) -> Self
pub fn set_typography(self, input: Option<Typography>) -> Self
Determines the typography options.
Sourcepub fn get_typography(&self) -> &Option<Typography>
pub fn get_typography(&self) -> &Option<Typography>
Determines the typography options.
Sourcepub fn build(self) -> ThemeConfiguration
pub fn build(self) -> ThemeConfiguration
Consumes the builder and constructs a ThemeConfiguration
.
Trait Implementations§
Source§impl Clone for ThemeConfigurationBuilder
impl Clone for ThemeConfigurationBuilder
Source§fn clone(&self) -> ThemeConfigurationBuilder
fn clone(&self) -> ThemeConfigurationBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ThemeConfigurationBuilder
impl Debug for ThemeConfigurationBuilder
Source§impl Default for ThemeConfigurationBuilder
impl Default for ThemeConfigurationBuilder
Source§fn default() -> ThemeConfigurationBuilder
fn default() -> ThemeConfigurationBuilder
Source§impl PartialEq for ThemeConfigurationBuilder
impl PartialEq for ThemeConfigurationBuilder
Source§fn eq(&self, other: &ThemeConfigurationBuilder) -> bool
fn eq(&self, other: &ThemeConfigurationBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for ThemeConfigurationBuilder
Auto Trait Implementations§
impl Freeze for ThemeConfigurationBuilder
impl RefUnwindSafe for ThemeConfigurationBuilder
impl Send for ThemeConfigurationBuilder
impl Sync for ThemeConfigurationBuilder
impl Unpin for ThemeConfigurationBuilder
impl UnwindSafe for ThemeConfigurationBuilder
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);