#[non_exhaustive]pub struct HistogramBinOptionsBuilder { /* private fields */ }
Expand description
A builder for HistogramBinOptions
.
Implementations§
Source§impl HistogramBinOptionsBuilder
impl HistogramBinOptionsBuilder
Sourcepub fn selected_bin_type(self, input: HistogramBinType) -> Self
pub fn selected_bin_type(self, input: HistogramBinType) -> Self
The options that determine the selected bin type.
Sourcepub fn set_selected_bin_type(self, input: Option<HistogramBinType>) -> Self
pub fn set_selected_bin_type(self, input: Option<HistogramBinType>) -> Self
The options that determine the selected bin type.
Sourcepub fn get_selected_bin_type(&self) -> &Option<HistogramBinType>
pub fn get_selected_bin_type(&self) -> &Option<HistogramBinType>
The options that determine the selected bin type.
Sourcepub fn bin_count(self, input: BinCountOptions) -> Self
pub fn bin_count(self, input: BinCountOptions) -> Self
The options that determine the bin count of a histogram.
Sourcepub fn set_bin_count(self, input: Option<BinCountOptions>) -> Self
pub fn set_bin_count(self, input: Option<BinCountOptions>) -> Self
The options that determine the bin count of a histogram.
Sourcepub fn get_bin_count(&self) -> &Option<BinCountOptions>
pub fn get_bin_count(&self) -> &Option<BinCountOptions>
The options that determine the bin count of a histogram.
Sourcepub fn bin_width(self, input: BinWidthOptions) -> Self
pub fn bin_width(self, input: BinWidthOptions) -> Self
The options that determine the bin width of a histogram.
Sourcepub fn set_bin_width(self, input: Option<BinWidthOptions>) -> Self
pub fn set_bin_width(self, input: Option<BinWidthOptions>) -> Self
The options that determine the bin width of a histogram.
Sourcepub fn get_bin_width(&self) -> &Option<BinWidthOptions>
pub fn get_bin_width(&self) -> &Option<BinWidthOptions>
The options that determine the bin width of a histogram.
Sourcepub fn start_value(self, input: f64) -> Self
pub fn start_value(self, input: f64) -> Self
The options that determine the bin start value.
Sourcepub fn set_start_value(self, input: Option<f64>) -> Self
pub fn set_start_value(self, input: Option<f64>) -> Self
The options that determine the bin start value.
Sourcepub fn get_start_value(&self) -> &Option<f64>
pub fn get_start_value(&self) -> &Option<f64>
The options that determine the bin start value.
Sourcepub fn build(self) -> HistogramBinOptions
pub fn build(self) -> HistogramBinOptions
Consumes the builder and constructs a HistogramBinOptions
.
Trait Implementations§
Source§impl Clone for HistogramBinOptionsBuilder
impl Clone for HistogramBinOptionsBuilder
Source§fn clone(&self) -> HistogramBinOptionsBuilder
fn clone(&self) -> HistogramBinOptionsBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for HistogramBinOptionsBuilder
impl Debug for HistogramBinOptionsBuilder
Source§impl Default for HistogramBinOptionsBuilder
impl Default for HistogramBinOptionsBuilder
Source§fn default() -> HistogramBinOptionsBuilder
fn default() -> HistogramBinOptionsBuilder
impl StructuralPartialEq for HistogramBinOptionsBuilder
Auto Trait Implementations§
impl Freeze for HistogramBinOptionsBuilder
impl RefUnwindSafe for HistogramBinOptionsBuilder
impl Send for HistogramBinOptionsBuilder
impl Sync for HistogramBinOptionsBuilder
impl Unpin for HistogramBinOptionsBuilder
impl UnwindSafe for HistogramBinOptionsBuilder
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);