#[non_exhaustive]pub struct AnalyticsIntentMetricBuilder { /* private fields */ }
Expand description
A builder for AnalyticsIntentMetric
.
Implementations§
Source§impl AnalyticsIntentMetricBuilder
impl AnalyticsIntentMetricBuilder
Sourcepub fn name(self, input: AnalyticsIntentMetricName) -> Self
pub fn name(self, input: AnalyticsIntentMetricName) -> Self
The metric for which you want to get intent summary statistics.
-
Count
– The number of times the intent was invoked. -
Success
– The number of times the intent succeeded. -
Failure
– The number of times the intent failed. -
Switched
– The number of times there was a switch to a different intent. -
Dropped
– The number of times the user dropped the intent.
Sourcepub fn set_name(self, input: Option<AnalyticsIntentMetricName>) -> Self
pub fn set_name(self, input: Option<AnalyticsIntentMetricName>) -> Self
The metric for which you want to get intent summary statistics.
-
Count
– The number of times the intent was invoked. -
Success
– The number of times the intent succeeded. -
Failure
– The number of times the intent failed. -
Switched
– The number of times there was a switch to a different intent. -
Dropped
– The number of times the user dropped the intent.
Sourcepub fn get_name(&self) -> &Option<AnalyticsIntentMetricName>
pub fn get_name(&self) -> &Option<AnalyticsIntentMetricName>
The metric for which you want to get intent summary statistics.
-
Count
– The number of times the intent was invoked. -
Success
– The number of times the intent succeeded. -
Failure
– The number of times the intent failed. -
Switched
– The number of times there was a switch to a different intent. -
Dropped
– The number of times the user dropped the intent.
Sourcepub fn statistic(self, input: AnalyticsMetricStatistic) -> Self
pub fn statistic(self, input: AnalyticsMetricStatistic) -> Self
The summary statistic to calculate.
-
Sum
– The total count for the category you provide inname
. -
Average
– The total count divided by the number of intents in the category you provide inname
. -
Max
– The highest count in the category you provide inname
.
Sourcepub fn set_statistic(self, input: Option<AnalyticsMetricStatistic>) -> Self
pub fn set_statistic(self, input: Option<AnalyticsMetricStatistic>) -> Self
The summary statistic to calculate.
-
Sum
– The total count for the category you provide inname
. -
Average
– The total count divided by the number of intents in the category you provide inname
. -
Max
– The highest count in the category you provide inname
.
Sourcepub fn get_statistic(&self) -> &Option<AnalyticsMetricStatistic>
pub fn get_statistic(&self) -> &Option<AnalyticsMetricStatistic>
The summary statistic to calculate.
-
Sum
– The total count for the category you provide inname
. -
Average
– The total count divided by the number of intents in the category you provide inname
. -
Max
– The highest count in the category you provide inname
.
Sourcepub fn order(self, input: AnalyticsSortOrder) -> Self
pub fn order(self, input: AnalyticsSortOrder) -> Self
Specifies whether to sort the results in ascending or descending order.
Sourcepub fn set_order(self, input: Option<AnalyticsSortOrder>) -> Self
pub fn set_order(self, input: Option<AnalyticsSortOrder>) -> Self
Specifies whether to sort the results in ascending or descending order.
Sourcepub fn get_order(&self) -> &Option<AnalyticsSortOrder>
pub fn get_order(&self) -> &Option<AnalyticsSortOrder>
Specifies whether to sort the results in ascending or descending order.
Sourcepub fn build(self) -> Result<AnalyticsIntentMetric, BuildError>
pub fn build(self) -> Result<AnalyticsIntentMetric, BuildError>
Consumes the builder and constructs a AnalyticsIntentMetric
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for AnalyticsIntentMetricBuilder
impl Clone for AnalyticsIntentMetricBuilder
Source§fn clone(&self) -> AnalyticsIntentMetricBuilder
fn clone(&self) -> AnalyticsIntentMetricBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for AnalyticsIntentMetricBuilder
impl Debug for AnalyticsIntentMetricBuilder
Source§impl Default for AnalyticsIntentMetricBuilder
impl Default for AnalyticsIntentMetricBuilder
Source§fn default() -> AnalyticsIntentMetricBuilder
fn default() -> AnalyticsIntentMetricBuilder
Source§impl PartialEq for AnalyticsIntentMetricBuilder
impl PartialEq for AnalyticsIntentMetricBuilder
Source§fn eq(&self, other: &AnalyticsIntentMetricBuilder) -> bool
fn eq(&self, other: &AnalyticsIntentMetricBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for AnalyticsIntentMetricBuilder
Auto Trait Implementations§
impl Freeze for AnalyticsIntentMetricBuilder
impl RefUnwindSafe for AnalyticsIntentMetricBuilder
impl Send for AnalyticsIntentMetricBuilder
impl Sync for AnalyticsIntentMetricBuilder
impl Unpin for AnalyticsIntentMetricBuilder
impl UnwindSafe for AnalyticsIntentMetricBuilder
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);