#[non_exhaustive]pub struct LegendOptionsBuilder { /* private fields */ }
Expand description
A builder for LegendOptions
.
Implementations§
Source§impl LegendOptionsBuilder
impl LegendOptionsBuilder
Sourcepub fn visibility(self, input: Visibility) -> Self
pub fn visibility(self, input: Visibility) -> Self
Determines whether or not the legend is visible.
Sourcepub fn set_visibility(self, input: Option<Visibility>) -> Self
pub fn set_visibility(self, input: Option<Visibility>) -> Self
Determines whether or not the legend is visible.
Sourcepub fn get_visibility(&self) -> &Option<Visibility>
pub fn get_visibility(&self) -> &Option<Visibility>
Determines whether or not the legend is visible.
Sourcepub fn title(self, input: LabelOptions) -> Self
pub fn title(self, input: LabelOptions) -> Self
The custom title for the legend.
Sourcepub fn set_title(self, input: Option<LabelOptions>) -> Self
pub fn set_title(self, input: Option<LabelOptions>) -> Self
The custom title for the legend.
Sourcepub fn get_title(&self) -> &Option<LabelOptions>
pub fn get_title(&self) -> &Option<LabelOptions>
The custom title for the legend.
Sourcepub fn position(self, input: LegendPosition) -> Self
pub fn position(self, input: LegendPosition) -> Self
The positions for the legend. Choose one of the following options:
-
AUTO
-
RIGHT
-
BOTTOM
-
LEFT
Sourcepub fn set_position(self, input: Option<LegendPosition>) -> Self
pub fn set_position(self, input: Option<LegendPosition>) -> Self
The positions for the legend. Choose one of the following options:
-
AUTO
-
RIGHT
-
BOTTOM
-
LEFT
Sourcepub fn get_position(&self) -> &Option<LegendPosition>
pub fn get_position(&self) -> &Option<LegendPosition>
The positions for the legend. Choose one of the following options:
-
AUTO
-
RIGHT
-
BOTTOM
-
LEFT
Sourcepub fn width(self, input: impl Into<String>) -> Self
pub fn width(self, input: impl Into<String>) -> Self
The width of the legend. If this value is omitted, a default width is used when rendering.
Sourcepub fn set_width(self, input: Option<String>) -> Self
pub fn set_width(self, input: Option<String>) -> Self
The width of the legend. If this value is omitted, a default width is used when rendering.
Sourcepub fn get_width(&self) -> &Option<String>
pub fn get_width(&self) -> &Option<String>
The width of the legend. If this value is omitted, a default width is used when rendering.
Sourcepub fn height(self, input: impl Into<String>) -> Self
pub fn height(self, input: impl Into<String>) -> Self
The height of the legend. If this value is omitted, a default height is used when rendering.
Sourcepub fn set_height(self, input: Option<String>) -> Self
pub fn set_height(self, input: Option<String>) -> Self
The height of the legend. If this value is omitted, a default height is used when rendering.
Sourcepub fn get_height(&self) -> &Option<String>
pub fn get_height(&self) -> &Option<String>
The height of the legend. If this value is omitted, a default height is used when rendering.
Sourcepub fn value_font_configuration(self, input: FontConfiguration) -> Self
pub fn value_font_configuration(self, input: FontConfiguration) -> Self
Configures the display properties of the given text.
Sourcepub fn set_value_font_configuration(
self,
input: Option<FontConfiguration>,
) -> Self
pub fn set_value_font_configuration( self, input: Option<FontConfiguration>, ) -> Self
Configures the display properties of the given text.
Sourcepub fn get_value_font_configuration(&self) -> &Option<FontConfiguration>
pub fn get_value_font_configuration(&self) -> &Option<FontConfiguration>
Configures the display properties of the given text.
Sourcepub fn build(self) -> LegendOptions
pub fn build(self) -> LegendOptions
Consumes the builder and constructs a LegendOptions
.
Trait Implementations§
Source§impl Clone for LegendOptionsBuilder
impl Clone for LegendOptionsBuilder
Source§fn clone(&self) -> LegendOptionsBuilder
fn clone(&self) -> LegendOptionsBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for LegendOptionsBuilder
impl Debug for LegendOptionsBuilder
Source§impl Default for LegendOptionsBuilder
impl Default for LegendOptionsBuilder
Source§fn default() -> LegendOptionsBuilder
fn default() -> LegendOptionsBuilder
Source§impl PartialEq for LegendOptionsBuilder
impl PartialEq for LegendOptionsBuilder
impl StructuralPartialEq for LegendOptionsBuilder
Auto Trait Implementations§
impl Freeze for LegendOptionsBuilder
impl RefUnwindSafe for LegendOptionsBuilder
impl Send for LegendOptionsBuilder
impl Sync for LegendOptionsBuilder
impl Unpin for LegendOptionsBuilder
impl UnwindSafe for LegendOptionsBuilder
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);