#[non_exhaustive]pub struct StatisticSummary {
pub statistic_id: Option<String>,
pub profile_id: Option<String>,
pub run_identifier: Option<RunIdentifier>,
pub statistic_name: Option<String>,
pub double_value: f64,
pub evaluation_level: Option<StatisticEvaluationLevel>,
pub columns_referenced: Option<Vec<String>>,
pub referenced_datasets: Option<Vec<String>>,
pub statistic_properties: Option<HashMap<String, String>>,
pub recorded_on: Option<DateTime>,
pub inclusion_annotation: Option<TimestampedInclusionAnnotation>,
}
Expand description
Summary information about a statistic.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.statistic_id: Option<String>
The Statistic ID.
profile_id: Option<String>
The Profile ID.
run_identifier: Option<RunIdentifier>
The Run Identifier
statistic_name: Option<String>
The name of the statistic.
double_value: f64
The value of the statistic.
evaluation_level: Option<StatisticEvaluationLevel>
The evaluation level of the statistic. Possible values: Dataset
, Column
, Multicolumn
.
columns_referenced: Option<Vec<String>>
The list of columns referenced by the statistic.
referenced_datasets: Option<Vec<String>>
The list of datasets referenced by the statistic.
statistic_properties: Option<HashMap<String, String>>
A StatisticPropertiesMap
, which contains a NameString
and DescriptionString
recorded_on: Option<DateTime>
The timestamp when the statistic was recorded.
inclusion_annotation: Option<TimestampedInclusionAnnotation>
The inclusion annotation for the statistic.
Implementations§
Source§impl StatisticSummary
impl StatisticSummary
Sourcepub fn statistic_id(&self) -> Option<&str>
pub fn statistic_id(&self) -> Option<&str>
The Statistic ID.
Sourcepub fn profile_id(&self) -> Option<&str>
pub fn profile_id(&self) -> Option<&str>
The Profile ID.
Sourcepub fn run_identifier(&self) -> Option<&RunIdentifier>
pub fn run_identifier(&self) -> Option<&RunIdentifier>
The Run Identifier
Sourcepub fn statistic_name(&self) -> Option<&str>
pub fn statistic_name(&self) -> Option<&str>
The name of the statistic.
Sourcepub fn double_value(&self) -> f64
pub fn double_value(&self) -> f64
The value of the statistic.
Sourcepub fn evaluation_level(&self) -> Option<&StatisticEvaluationLevel>
pub fn evaluation_level(&self) -> Option<&StatisticEvaluationLevel>
The evaluation level of the statistic. Possible values: Dataset
, Column
, Multicolumn
.
Sourcepub fn columns_referenced(&self) -> &[String]
pub fn columns_referenced(&self) -> &[String]
The list of columns referenced by the statistic.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .columns_referenced.is_none()
.
Sourcepub fn referenced_datasets(&self) -> &[String]
pub fn referenced_datasets(&self) -> &[String]
The list of datasets referenced by the statistic.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .referenced_datasets.is_none()
.
Sourcepub fn statistic_properties(&self) -> Option<&HashMap<String, String>>
pub fn statistic_properties(&self) -> Option<&HashMap<String, String>>
A StatisticPropertiesMap
, which contains a NameString
and DescriptionString
Sourcepub fn recorded_on(&self) -> Option<&DateTime>
pub fn recorded_on(&self) -> Option<&DateTime>
The timestamp when the statistic was recorded.
Sourcepub fn inclusion_annotation(&self) -> Option<&TimestampedInclusionAnnotation>
pub fn inclusion_annotation(&self) -> Option<&TimestampedInclusionAnnotation>
The inclusion annotation for the statistic.
Source§impl StatisticSummary
impl StatisticSummary
Sourcepub fn builder() -> StatisticSummaryBuilder
pub fn builder() -> StatisticSummaryBuilder
Creates a new builder-style object to manufacture StatisticSummary
.
Trait Implementations§
Source§impl Clone for StatisticSummary
impl Clone for StatisticSummary
Source§fn clone(&self) -> StatisticSummary
fn clone(&self) -> StatisticSummary
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for StatisticSummary
impl Debug for StatisticSummary
Source§impl PartialEq for StatisticSummary
impl PartialEq for StatisticSummary
impl StructuralPartialEq for StatisticSummary
Auto Trait Implementations§
impl Freeze for StatisticSummary
impl RefUnwindSafe for StatisticSummary
impl Send for StatisticSummary
impl Sync for StatisticSummary
impl Unpin for StatisticSummary
impl UnwindSafe for StatisticSummary
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);