#[non_exhaustive]pub struct StatisticSummaryBuilder { /* private fields */ }
Expand description
A builder for StatisticSummary
.
Implementations§
Source§impl StatisticSummaryBuilder
impl StatisticSummaryBuilder
Sourcepub fn statistic_id(self, input: impl Into<String>) -> Self
pub fn statistic_id(self, input: impl Into<String>) -> Self
The Statistic ID.
Sourcepub fn set_statistic_id(self, input: Option<String>) -> Self
pub fn set_statistic_id(self, input: Option<String>) -> Self
The Statistic ID.
Sourcepub fn get_statistic_id(&self) -> &Option<String>
pub fn get_statistic_id(&self) -> &Option<String>
The Statistic ID.
Sourcepub fn profile_id(self, input: impl Into<String>) -> Self
pub fn profile_id(self, input: impl Into<String>) -> Self
The Profile ID.
Sourcepub fn set_profile_id(self, input: Option<String>) -> Self
pub fn set_profile_id(self, input: Option<String>) -> Self
The Profile ID.
Sourcepub fn get_profile_id(&self) -> &Option<String>
pub fn get_profile_id(&self) -> &Option<String>
The Profile ID.
Sourcepub fn run_identifier(self, input: RunIdentifier) -> Self
pub fn run_identifier(self, input: RunIdentifier) -> Self
The Run Identifier
Sourcepub fn set_run_identifier(self, input: Option<RunIdentifier>) -> Self
pub fn set_run_identifier(self, input: Option<RunIdentifier>) -> Self
The Run Identifier
Sourcepub fn get_run_identifier(&self) -> &Option<RunIdentifier>
pub fn get_run_identifier(&self) -> &Option<RunIdentifier>
The Run Identifier
Sourcepub fn statistic_name(self, input: impl Into<String>) -> Self
pub fn statistic_name(self, input: impl Into<String>) -> Self
The name of the statistic.
Sourcepub fn set_statistic_name(self, input: Option<String>) -> Self
pub fn set_statistic_name(self, input: Option<String>) -> Self
The name of the statistic.
Sourcepub fn get_statistic_name(&self) -> &Option<String>
pub fn get_statistic_name(&self) -> &Option<String>
The name of the statistic.
Sourcepub fn double_value(self, input: f64) -> Self
pub fn double_value(self, input: f64) -> Self
The value of the statistic.
Sourcepub fn set_double_value(self, input: Option<f64>) -> Self
pub fn set_double_value(self, input: Option<f64>) -> Self
The value of the statistic.
Sourcepub fn get_double_value(&self) -> &Option<f64>
pub fn get_double_value(&self) -> &Option<f64>
The value of the statistic.
Sourcepub fn evaluation_level(self, input: StatisticEvaluationLevel) -> Self
pub fn evaluation_level(self, input: StatisticEvaluationLevel) -> Self
The evaluation level of the statistic. Possible values: Dataset
, Column
, Multicolumn
.
Sourcepub fn set_evaluation_level(
self,
input: Option<StatisticEvaluationLevel>,
) -> Self
pub fn set_evaluation_level( self, input: Option<StatisticEvaluationLevel>, ) -> Self
The evaluation level of the statistic. Possible values: Dataset
, Column
, Multicolumn
.
Sourcepub fn get_evaluation_level(&self) -> &Option<StatisticEvaluationLevel>
pub fn get_evaluation_level(&self) -> &Option<StatisticEvaluationLevel>
The evaluation level of the statistic. Possible values: Dataset
, Column
, Multicolumn
.
Sourcepub fn columns_referenced(self, input: impl Into<String>) -> Self
pub fn columns_referenced(self, input: impl Into<String>) -> Self
Appends an item to columns_referenced
.
To override the contents of this collection use set_columns_referenced
.
The list of columns referenced by the statistic.
Sourcepub fn set_columns_referenced(self, input: Option<Vec<String>>) -> Self
pub fn set_columns_referenced(self, input: Option<Vec<String>>) -> Self
The list of columns referenced by the statistic.
Sourcepub fn get_columns_referenced(&self) -> &Option<Vec<String>>
pub fn get_columns_referenced(&self) -> &Option<Vec<String>>
The list of columns referenced by the statistic.
Sourcepub fn referenced_datasets(self, input: impl Into<String>) -> Self
pub fn referenced_datasets(self, input: impl Into<String>) -> Self
Appends an item to referenced_datasets
.
To override the contents of this collection use set_referenced_datasets
.
The list of datasets referenced by the statistic.
Sourcepub fn set_referenced_datasets(self, input: Option<Vec<String>>) -> Self
pub fn set_referenced_datasets(self, input: Option<Vec<String>>) -> Self
The list of datasets referenced by the statistic.
Sourcepub fn get_referenced_datasets(&self) -> &Option<Vec<String>>
pub fn get_referenced_datasets(&self) -> &Option<Vec<String>>
The list of datasets referenced by the statistic.
Sourcepub fn statistic_properties(
self,
k: impl Into<String>,
v: impl Into<String>,
) -> Self
pub fn statistic_properties( self, k: impl Into<String>, v: impl Into<String>, ) -> Self
Adds a key-value pair to statistic_properties
.
To override the contents of this collection use set_statistic_properties
.
A StatisticPropertiesMap
, which contains a NameString
and DescriptionString
Sourcepub fn set_statistic_properties(
self,
input: Option<HashMap<String, String>>,
) -> Self
pub fn set_statistic_properties( self, input: Option<HashMap<String, String>>, ) -> Self
A StatisticPropertiesMap
, which contains a NameString
and DescriptionString
Sourcepub fn get_statistic_properties(&self) -> &Option<HashMap<String, String>>
pub fn get_statistic_properties(&self) -> &Option<HashMap<String, String>>
A StatisticPropertiesMap
, which contains a NameString
and DescriptionString
Sourcepub fn recorded_on(self, input: DateTime) -> Self
pub fn recorded_on(self, input: DateTime) -> Self
The timestamp when the statistic was recorded.
Sourcepub fn set_recorded_on(self, input: Option<DateTime>) -> Self
pub fn set_recorded_on(self, input: Option<DateTime>) -> Self
The timestamp when the statistic was recorded.
Sourcepub fn get_recorded_on(&self) -> &Option<DateTime>
pub fn get_recorded_on(&self) -> &Option<DateTime>
The timestamp when the statistic was recorded.
Sourcepub fn inclusion_annotation(self, input: TimestampedInclusionAnnotation) -> Self
pub fn inclusion_annotation(self, input: TimestampedInclusionAnnotation) -> Self
The inclusion annotation for the statistic.
Sourcepub fn set_inclusion_annotation(
self,
input: Option<TimestampedInclusionAnnotation>,
) -> Self
pub fn set_inclusion_annotation( self, input: Option<TimestampedInclusionAnnotation>, ) -> Self
The inclusion annotation for the statistic.
Sourcepub fn get_inclusion_annotation(
&self,
) -> &Option<TimestampedInclusionAnnotation>
pub fn get_inclusion_annotation( &self, ) -> &Option<TimestampedInclusionAnnotation>
The inclusion annotation for the statistic.
Sourcepub fn build(self) -> StatisticSummary
pub fn build(self) -> StatisticSummary
Consumes the builder and constructs a StatisticSummary
.
Trait Implementations§
Source§impl Clone for StatisticSummaryBuilder
impl Clone for StatisticSummaryBuilder
Source§fn clone(&self) -> StatisticSummaryBuilder
fn clone(&self) -> StatisticSummaryBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for StatisticSummaryBuilder
impl Debug for StatisticSummaryBuilder
Source§impl Default for StatisticSummaryBuilder
impl Default for StatisticSummaryBuilder
Source§fn default() -> StatisticSummaryBuilder
fn default() -> StatisticSummaryBuilder
Source§impl PartialEq for StatisticSummaryBuilder
impl PartialEq for StatisticSummaryBuilder
impl StructuralPartialEq for StatisticSummaryBuilder
Auto Trait Implementations§
impl Freeze for StatisticSummaryBuilder
impl RefUnwindSafe for StatisticSummaryBuilder
impl Send for StatisticSummaryBuilder
impl Sync for StatisticSummaryBuilder
impl Unpin for StatisticSummaryBuilder
impl UnwindSafe for StatisticSummaryBuilder
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);