#[non_exhaustive]pub struct ThemeBuilder { /* private fields */ }
Expand description
A builder for Theme
.
Implementations§
Source§impl ThemeBuilder
impl ThemeBuilder
Sourcepub fn stack_name(self, input: impl Into<String>) -> Self
pub fn stack_name(self, input: impl Into<String>) -> Self
The stack that has the custom branding theme.
Sourcepub fn set_stack_name(self, input: Option<String>) -> Self
pub fn set_stack_name(self, input: Option<String>) -> Self
The stack that has the custom branding theme.
Sourcepub fn get_stack_name(&self) -> &Option<String>
pub fn get_stack_name(&self) -> &Option<String>
The stack that has the custom branding theme.
Sourcepub fn state(self, input: ThemeState) -> Self
pub fn state(self, input: ThemeState) -> Self
The state of the theme.
Sourcepub fn set_state(self, input: Option<ThemeState>) -> Self
pub fn set_state(self, input: Option<ThemeState>) -> Self
The state of the theme.
Sourcepub fn get_state(&self) -> &Option<ThemeState>
pub fn get_state(&self) -> &Option<ThemeState>
The state of the theme.
Sourcepub fn theme_title_text(self, input: impl Into<String>) -> Self
pub fn theme_title_text(self, input: impl Into<String>) -> Self
The browser tab page title.
Sourcepub fn set_theme_title_text(self, input: Option<String>) -> Self
pub fn set_theme_title_text(self, input: Option<String>) -> Self
The browser tab page title.
Sourcepub fn get_theme_title_text(&self) -> &Option<String>
pub fn get_theme_title_text(&self) -> &Option<String>
The browser tab page title.
Sourcepub fn theme_styling(self, input: ThemeStyling) -> Self
pub fn theme_styling(self, input: ThemeStyling) -> Self
The color that is used for the website links, text, buttons, and catalog page background.
Sourcepub fn set_theme_styling(self, input: Option<ThemeStyling>) -> Self
pub fn set_theme_styling(self, input: Option<ThemeStyling>) -> Self
The color that is used for the website links, text, buttons, and catalog page background.
Sourcepub fn get_theme_styling(&self) -> &Option<ThemeStyling>
pub fn get_theme_styling(&self) -> &Option<ThemeStyling>
The color that is used for the website links, text, buttons, and catalog page background.
Appends an item to theme_footer_links
.
To override the contents of this collection use set_theme_footer_links
.
The website links that display in the catalog page footer.
The website links that display in the catalog page footer.
The website links that display in the catalog page footer.
Sourcepub fn theme_organization_logo_url(self, input: impl Into<String>) -> Self
pub fn theme_organization_logo_url(self, input: impl Into<String>) -> Self
The URL of the logo that displays in the catalog page header.
Sourcepub fn set_theme_organization_logo_url(self, input: Option<String>) -> Self
pub fn set_theme_organization_logo_url(self, input: Option<String>) -> Self
The URL of the logo that displays in the catalog page header.
Sourcepub fn get_theme_organization_logo_url(&self) -> &Option<String>
pub fn get_theme_organization_logo_url(&self) -> &Option<String>
The URL of the logo that displays in the catalog page header.
Sourcepub fn theme_favicon_url(self, input: impl Into<String>) -> Self
pub fn theme_favicon_url(self, input: impl Into<String>) -> Self
The URL of the icon that displays at the top of a user's browser tab during streaming sessions.
Sourcepub fn set_theme_favicon_url(self, input: Option<String>) -> Self
pub fn set_theme_favicon_url(self, input: Option<String>) -> Self
The URL of the icon that displays at the top of a user's browser tab during streaming sessions.
Sourcepub fn get_theme_favicon_url(&self) -> &Option<String>
pub fn get_theme_favicon_url(&self) -> &Option<String>
The URL of the icon that displays at the top of a user's browser tab during streaming sessions.
Sourcepub fn created_time(self, input: DateTime) -> Self
pub fn created_time(self, input: DateTime) -> Self
The time the theme was created.
Sourcepub fn set_created_time(self, input: Option<DateTime>) -> Self
pub fn set_created_time(self, input: Option<DateTime>) -> Self
The time the theme was created.
Sourcepub fn get_created_time(&self) -> &Option<DateTime>
pub fn get_created_time(&self) -> &Option<DateTime>
The time the theme was created.
Trait Implementations§
Source§impl Clone for ThemeBuilder
impl Clone for ThemeBuilder
Source§fn clone(&self) -> ThemeBuilder
fn clone(&self) -> ThemeBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ThemeBuilder
impl Debug for ThemeBuilder
Source§impl Default for ThemeBuilder
impl Default for ThemeBuilder
Source§fn default() -> ThemeBuilder
fn default() -> ThemeBuilder
Source§impl PartialEq for ThemeBuilder
impl PartialEq for ThemeBuilder
impl StructuralPartialEq for ThemeBuilder
Auto Trait Implementations§
impl Freeze for ThemeBuilder
impl RefUnwindSafe for ThemeBuilder
impl Send for ThemeBuilder
impl Sync for ThemeBuilder
impl Unpin for ThemeBuilder
impl UnwindSafe for ThemeBuilder
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);