#[non_exhaustive]pub struct VisualSubtitleFontConfigurationBuilder { /* private fields */ }Expand description
A builder for VisualSubtitleFontConfiguration.
Implementations§
Source§impl VisualSubtitleFontConfigurationBuilder
impl VisualSubtitleFontConfigurationBuilder
Sourcepub fn font_configuration(self, input: FontConfiguration) -> Self
pub fn font_configuration(self, input: FontConfiguration) -> Self
Configures the display properties of the given text.
Sourcepub fn set_font_configuration(self, input: Option<FontConfiguration>) -> Self
pub fn set_font_configuration(self, input: Option<FontConfiguration>) -> Self
Configures the display properties of the given text.
Sourcepub fn get_font_configuration(&self) -> &Option<FontConfiguration>
pub fn get_font_configuration(&self) -> &Option<FontConfiguration>
Configures the display properties of the given text.
Sourcepub fn text_alignment(self, input: HorizontalTextAlignment) -> Self
pub fn text_alignment(self, input: HorizontalTextAlignment) -> Self
Determines the alignment of visual sub-title.
Sourcepub fn set_text_alignment(self, input: Option<HorizontalTextAlignment>) -> Self
pub fn set_text_alignment(self, input: Option<HorizontalTextAlignment>) -> Self
Determines the alignment of visual sub-title.
Sourcepub fn get_text_alignment(&self) -> &Option<HorizontalTextAlignment>
pub fn get_text_alignment(&self) -> &Option<HorizontalTextAlignment>
Determines the alignment of visual sub-title.
Sourcepub fn text_transform(self, input: TextTransform) -> Self
pub fn text_transform(self, input: TextTransform) -> Self
Determines the text transformation of visual sub-title.
Sourcepub fn set_text_transform(self, input: Option<TextTransform>) -> Self
pub fn set_text_transform(self, input: Option<TextTransform>) -> Self
Determines the text transformation of visual sub-title.
Sourcepub fn get_text_transform(&self) -> &Option<TextTransform>
pub fn get_text_transform(&self) -> &Option<TextTransform>
Determines the text transformation of visual sub-title.
Sourcepub fn build(self) -> VisualSubtitleFontConfiguration
pub fn build(self) -> VisualSubtitleFontConfiguration
Consumes the builder and constructs a VisualSubtitleFontConfiguration.
Trait Implementations§
Source§impl Clone for VisualSubtitleFontConfigurationBuilder
impl Clone for VisualSubtitleFontConfigurationBuilder
Source§fn clone(&self) -> VisualSubtitleFontConfigurationBuilder
fn clone(&self) -> VisualSubtitleFontConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Default for VisualSubtitleFontConfigurationBuilder
impl Default for VisualSubtitleFontConfigurationBuilder
Source§fn default() -> VisualSubtitleFontConfigurationBuilder
fn default() -> VisualSubtitleFontConfigurationBuilder
Source§impl PartialEq for VisualSubtitleFontConfigurationBuilder
impl PartialEq for VisualSubtitleFontConfigurationBuilder
Source§fn eq(&self, other: &VisualSubtitleFontConfigurationBuilder) -> bool
fn eq(&self, other: &VisualSubtitleFontConfigurationBuilder) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for VisualSubtitleFontConfigurationBuilder
Auto Trait Implementations§
impl Freeze for VisualSubtitleFontConfigurationBuilder
impl RefUnwindSafe for VisualSubtitleFontConfigurationBuilder
impl Send for VisualSubtitleFontConfigurationBuilder
impl Sync for VisualSubtitleFontConfigurationBuilder
impl Unpin for VisualSubtitleFontConfigurationBuilder
impl UnwindSafe for VisualSubtitleFontConfigurationBuilder
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);