#[non_exhaustive]pub struct FontConfigurationBuilder { /* private fields */ }
Expand description
A builder for FontConfiguration
.
Implementations§
Source§impl FontConfigurationBuilder
impl FontConfigurationBuilder
Sourcepub fn font_size(self, input: FontSize) -> Self
pub fn font_size(self, input: FontSize) -> Self
The option that determines the text display size.
Sourcepub fn set_font_size(self, input: Option<FontSize>) -> Self
pub fn set_font_size(self, input: Option<FontSize>) -> Self
The option that determines the text display size.
Sourcepub fn get_font_size(&self) -> &Option<FontSize>
pub fn get_font_size(&self) -> &Option<FontSize>
The option that determines the text display size.
Sourcepub fn font_decoration(self, input: FontDecoration) -> Self
pub fn font_decoration(self, input: FontDecoration) -> Self
Determines the appearance of decorative lines on the text.
Sourcepub fn set_font_decoration(self, input: Option<FontDecoration>) -> Self
pub fn set_font_decoration(self, input: Option<FontDecoration>) -> Self
Determines the appearance of decorative lines on the text.
Sourcepub fn get_font_decoration(&self) -> &Option<FontDecoration>
pub fn get_font_decoration(&self) -> &Option<FontDecoration>
Determines the appearance of decorative lines on the text.
Sourcepub fn font_color(self, input: impl Into<String>) -> Self
pub fn font_color(self, input: impl Into<String>) -> Self
Determines the color of the text.
Sourcepub fn set_font_color(self, input: Option<String>) -> Self
pub fn set_font_color(self, input: Option<String>) -> Self
Determines the color of the text.
Sourcepub fn get_font_color(&self) -> &Option<String>
pub fn get_font_color(&self) -> &Option<String>
Determines the color of the text.
Sourcepub fn font_weight(self, input: FontWeight) -> Self
pub fn font_weight(self, input: FontWeight) -> Self
The option that determines the text display weight, or boldness.
Sourcepub fn set_font_weight(self, input: Option<FontWeight>) -> Self
pub fn set_font_weight(self, input: Option<FontWeight>) -> Self
The option that determines the text display weight, or boldness.
Sourcepub fn get_font_weight(&self) -> &Option<FontWeight>
pub fn get_font_weight(&self) -> &Option<FontWeight>
The option that determines the text display weight, or boldness.
Sourcepub fn font_style(self, input: FontStyle) -> Self
pub fn font_style(self, input: FontStyle) -> Self
Determines the text display face that is inherited by the given font family.
Sourcepub fn set_font_style(self, input: Option<FontStyle>) -> Self
pub fn set_font_style(self, input: Option<FontStyle>) -> Self
Determines the text display face that is inherited by the given font family.
Sourcepub fn get_font_style(&self) -> &Option<FontStyle>
pub fn get_font_style(&self) -> &Option<FontStyle>
Determines the text display face that is inherited by the given font family.
Sourcepub fn font_family(self, input: impl Into<String>) -> Self
pub fn font_family(self, input: impl Into<String>) -> Self
The font family that you want to use.
Sourcepub fn set_font_family(self, input: Option<String>) -> Self
pub fn set_font_family(self, input: Option<String>) -> Self
The font family that you want to use.
Sourcepub fn get_font_family(&self) -> &Option<String>
pub fn get_font_family(&self) -> &Option<String>
The font family that you want to use.
Sourcepub fn build(self) -> FontConfiguration
pub fn build(self) -> FontConfiguration
Consumes the builder and constructs a FontConfiguration
.
Trait Implementations§
Source§impl Clone for FontConfigurationBuilder
impl Clone for FontConfigurationBuilder
Source§fn clone(&self) -> FontConfigurationBuilder
fn clone(&self) -> FontConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for FontConfigurationBuilder
impl Debug for FontConfigurationBuilder
Source§impl Default for FontConfigurationBuilder
impl Default for FontConfigurationBuilder
Source§fn default() -> FontConfigurationBuilder
fn default() -> FontConfigurationBuilder
Source§impl PartialEq for FontConfigurationBuilder
impl PartialEq for FontConfigurationBuilder
impl StructuralPartialEq for FontConfigurationBuilder
Auto Trait Implementations§
impl Freeze for FontConfigurationBuilder
impl RefUnwindSafe for FontConfigurationBuilder
impl Send for FontConfigurationBuilder
impl Sync for FontConfigurationBuilder
impl Unpin for FontConfigurationBuilder
impl UnwindSafe for FontConfigurationBuilder
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);