#[non_exhaustive]pub struct StatisticsBuilder { /* private fields */ }
Expand description
A builder for Statistics
.
Implementations§
Source§impl StatisticsBuilder
impl StatisticsBuilder
Sourcepub fn count(self, input: i32) -> Self
pub fn count(self, input: i32) -> Self
The count of things that match the query string criteria and contain a valid aggregation field value.
Sourcepub fn set_count(self, input: Option<i32>) -> Self
pub fn set_count(self, input: Option<i32>) -> Self
The count of things that match the query string criteria and contain a valid aggregation field value.
Sourcepub fn get_count(&self) -> &Option<i32>
pub fn get_count(&self) -> &Option<i32>
The count of things that match the query string criteria and contain a valid aggregation field value.
Sourcepub fn set_average(self, input: Option<f64>) -> Self
pub fn set_average(self, input: Option<f64>) -> Self
The average of the aggregated field values.
Sourcepub fn get_average(&self) -> &Option<f64>
pub fn get_average(&self) -> &Option<f64>
The average of the aggregated field values.
Sourcepub fn set_minimum(self, input: Option<f64>) -> Self
pub fn set_minimum(self, input: Option<f64>) -> Self
The minimum aggregated field value.
Sourcepub fn get_minimum(&self) -> &Option<f64>
pub fn get_minimum(&self) -> &Option<f64>
The minimum aggregated field value.
Sourcepub fn set_maximum(self, input: Option<f64>) -> Self
pub fn set_maximum(self, input: Option<f64>) -> Self
The maximum aggregated field value.
Sourcepub fn get_maximum(&self) -> &Option<f64>
pub fn get_maximum(&self) -> &Option<f64>
The maximum aggregated field value.
Sourcepub fn sum_of_squares(self, input: f64) -> Self
pub fn sum_of_squares(self, input: f64) -> Self
The sum of the squares of the aggregated field values.
Sourcepub fn set_sum_of_squares(self, input: Option<f64>) -> Self
pub fn set_sum_of_squares(self, input: Option<f64>) -> Self
The sum of the squares of the aggregated field values.
Sourcepub fn get_sum_of_squares(&self) -> &Option<f64>
pub fn get_sum_of_squares(&self) -> &Option<f64>
The sum of the squares of the aggregated field values.
Sourcepub fn set_variance(self, input: Option<f64>) -> Self
pub fn set_variance(self, input: Option<f64>) -> Self
The variance of the aggregated field values.
Sourcepub fn get_variance(&self) -> &Option<f64>
pub fn get_variance(&self) -> &Option<f64>
The variance of the aggregated field values.
Sourcepub fn std_deviation(self, input: f64) -> Self
pub fn std_deviation(self, input: f64) -> Self
The standard deviation of the aggregated field values.
Sourcepub fn set_std_deviation(self, input: Option<f64>) -> Self
pub fn set_std_deviation(self, input: Option<f64>) -> Self
The standard deviation of the aggregated field values.
Sourcepub fn get_std_deviation(&self) -> &Option<f64>
pub fn get_std_deviation(&self) -> &Option<f64>
The standard deviation of the aggregated field values.
Sourcepub fn build(self) -> Statistics
pub fn build(self) -> Statistics
Consumes the builder and constructs a Statistics
.
Trait Implementations§
Source§impl Clone for StatisticsBuilder
impl Clone for StatisticsBuilder
Source§fn clone(&self) -> StatisticsBuilder
fn clone(&self) -> StatisticsBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for StatisticsBuilder
impl Debug for StatisticsBuilder
Source§impl Default for StatisticsBuilder
impl Default for StatisticsBuilder
Source§fn default() -> StatisticsBuilder
fn default() -> StatisticsBuilder
Source§impl PartialEq for StatisticsBuilder
impl PartialEq for StatisticsBuilder
impl StructuralPartialEq for StatisticsBuilder
Auto Trait Implementations§
impl Freeze for StatisticsBuilder
impl RefUnwindSafe for StatisticsBuilder
impl Send for StatisticsBuilder
impl Sync for StatisticsBuilder
impl Unpin for StatisticsBuilder
impl UnwindSafe for StatisticsBuilder
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);