#[non_exhaustive]pub struct PanelConfigurationBuilder { /* private fields */ }
Expand description
A builder for PanelConfiguration
.
Implementations§
Source§impl PanelConfigurationBuilder
impl PanelConfigurationBuilder
Sourcepub fn title(self, input: PanelTitleOptions) -> Self
pub fn title(self, input: PanelTitleOptions) -> Self
Configures the title display within each small multiples panel.
Sourcepub fn set_title(self, input: Option<PanelTitleOptions>) -> Self
pub fn set_title(self, input: Option<PanelTitleOptions>) -> Self
Configures the title display within each small multiples panel.
Sourcepub fn get_title(&self) -> &Option<PanelTitleOptions>
pub fn get_title(&self) -> &Option<PanelTitleOptions>
Configures the title display within each small multiples panel.
Sourcepub fn border_visibility(self, input: Visibility) -> Self
pub fn border_visibility(self, input: Visibility) -> Self
Determines whether or not each panel displays a border.
Sourcepub fn set_border_visibility(self, input: Option<Visibility>) -> Self
pub fn set_border_visibility(self, input: Option<Visibility>) -> Self
Determines whether or not each panel displays a border.
Sourcepub fn get_border_visibility(&self) -> &Option<Visibility>
pub fn get_border_visibility(&self) -> &Option<Visibility>
Determines whether or not each panel displays a border.
Sourcepub fn border_thickness(self, input: impl Into<String>) -> Self
pub fn border_thickness(self, input: impl Into<String>) -> Self
Sets the line thickness of panel borders.
Sourcepub fn set_border_thickness(self, input: Option<String>) -> Self
pub fn set_border_thickness(self, input: Option<String>) -> Self
Sets the line thickness of panel borders.
Sourcepub fn get_border_thickness(&self) -> &Option<String>
pub fn get_border_thickness(&self) -> &Option<String>
Sets the line thickness of panel borders.
Sourcepub fn border_style(self, input: PanelBorderStyle) -> Self
pub fn border_style(self, input: PanelBorderStyle) -> Self
Sets the line style of panel borders.
Sourcepub fn set_border_style(self, input: Option<PanelBorderStyle>) -> Self
pub fn set_border_style(self, input: Option<PanelBorderStyle>) -> Self
Sets the line style of panel borders.
Sourcepub fn get_border_style(&self) -> &Option<PanelBorderStyle>
pub fn get_border_style(&self) -> &Option<PanelBorderStyle>
Sets the line style of panel borders.
Sourcepub fn border_color(self, input: impl Into<String>) -> Self
pub fn border_color(self, input: impl Into<String>) -> Self
Sets the line color of panel borders.
Sourcepub fn set_border_color(self, input: Option<String>) -> Self
pub fn set_border_color(self, input: Option<String>) -> Self
Sets the line color of panel borders.
Sourcepub fn get_border_color(&self) -> &Option<String>
pub fn get_border_color(&self) -> &Option<String>
Sets the line color of panel borders.
Sourcepub fn gutter_visibility(self, input: Visibility) -> Self
pub fn gutter_visibility(self, input: Visibility) -> Self
Determines whether or not negative space between sibling panels is rendered.
Sourcepub fn set_gutter_visibility(self, input: Option<Visibility>) -> Self
pub fn set_gutter_visibility(self, input: Option<Visibility>) -> Self
Determines whether or not negative space between sibling panels is rendered.
Sourcepub fn get_gutter_visibility(&self) -> &Option<Visibility>
pub fn get_gutter_visibility(&self) -> &Option<Visibility>
Determines whether or not negative space between sibling panels is rendered.
Sourcepub fn gutter_spacing(self, input: impl Into<String>) -> Self
pub fn gutter_spacing(self, input: impl Into<String>) -> Self
Sets the total amount of negative space to display between sibling panels.
Sourcepub fn set_gutter_spacing(self, input: Option<String>) -> Self
pub fn set_gutter_spacing(self, input: Option<String>) -> Self
Sets the total amount of negative space to display between sibling panels.
Sourcepub fn get_gutter_spacing(&self) -> &Option<String>
pub fn get_gutter_spacing(&self) -> &Option<String>
Sets the total amount of negative space to display between sibling panels.
Sourcepub fn background_visibility(self, input: Visibility) -> Self
pub fn background_visibility(self, input: Visibility) -> Self
Determines whether or not a background for each small multiples panel is rendered.
Sourcepub fn set_background_visibility(self, input: Option<Visibility>) -> Self
pub fn set_background_visibility(self, input: Option<Visibility>) -> Self
Determines whether or not a background for each small multiples panel is rendered.
Sourcepub fn get_background_visibility(&self) -> &Option<Visibility>
pub fn get_background_visibility(&self) -> &Option<Visibility>
Determines whether or not a background for each small multiples panel is rendered.
Sourcepub fn background_color(self, input: impl Into<String>) -> Self
pub fn background_color(self, input: impl Into<String>) -> Self
Sets the background color for each panel.
Sourcepub fn set_background_color(self, input: Option<String>) -> Self
pub fn set_background_color(self, input: Option<String>) -> Self
Sets the background color for each panel.
Sourcepub fn get_background_color(&self) -> &Option<String>
pub fn get_background_color(&self) -> &Option<String>
Sets the background color for each panel.
Sourcepub fn build(self) -> PanelConfiguration
pub fn build(self) -> PanelConfiguration
Consumes the builder and constructs a PanelConfiguration
.
Trait Implementations§
Source§impl Clone for PanelConfigurationBuilder
impl Clone for PanelConfigurationBuilder
Source§fn clone(&self) -> PanelConfigurationBuilder
fn clone(&self) -> PanelConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for PanelConfigurationBuilder
impl Debug for PanelConfigurationBuilder
Source§impl Default for PanelConfigurationBuilder
impl Default for PanelConfigurationBuilder
Source§fn default() -> PanelConfigurationBuilder
fn default() -> PanelConfigurationBuilder
impl StructuralPartialEq for PanelConfigurationBuilder
Auto Trait Implementations§
impl Freeze for PanelConfigurationBuilder
impl RefUnwindSafe for PanelConfigurationBuilder
impl Send for PanelConfigurationBuilder
impl Sync for PanelConfigurationBuilder
impl Unpin for PanelConfigurationBuilder
impl UnwindSafe for PanelConfigurationBuilder
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);