#[non_exhaustive]pub struct AuthenticationResultBuilder { /* private fields */ }
Expand description
A builder for AuthenticationResult
.
Implementations§
Source§impl AuthenticationResultBuilder
impl AuthenticationResultBuilder
Sourcepub fn authentication_result_id(self, input: impl Into<String>) -> Self
pub fn authentication_result_id(self, input: impl Into<String>) -> Self
The unique identifier for this authentication result. Because there can be multiple authentications for a given session, this field helps to identify if the returned result is from a previous streaming activity or a new result. Note that in absence of any new streaming activity, AcceptanceThreshold
changes, or SpeakerId
changes, Voice ID always returns cached Authentication Result for this API.
Sourcepub fn set_authentication_result_id(self, input: Option<String>) -> Self
pub fn set_authentication_result_id(self, input: Option<String>) -> Self
The unique identifier for this authentication result. Because there can be multiple authentications for a given session, this field helps to identify if the returned result is from a previous streaming activity or a new result. Note that in absence of any new streaming activity, AcceptanceThreshold
changes, or SpeakerId
changes, Voice ID always returns cached Authentication Result for this API.
Sourcepub fn get_authentication_result_id(&self) -> &Option<String>
pub fn get_authentication_result_id(&self) -> &Option<String>
The unique identifier for this authentication result. Because there can be multiple authentications for a given session, this field helps to identify if the returned result is from a previous streaming activity or a new result. Note that in absence of any new streaming activity, AcceptanceThreshold
changes, or SpeakerId
changes, Voice ID always returns cached Authentication Result for this API.
Sourcepub fn audio_aggregation_started_at(self, input: DateTime) -> Self
pub fn audio_aggregation_started_at(self, input: DateTime) -> Self
A timestamp of when audio aggregation started for this authentication result.
Sourcepub fn set_audio_aggregation_started_at(self, input: Option<DateTime>) -> Self
pub fn set_audio_aggregation_started_at(self, input: Option<DateTime>) -> Self
A timestamp of when audio aggregation started for this authentication result.
Sourcepub fn get_audio_aggregation_started_at(&self) -> &Option<DateTime>
pub fn get_audio_aggregation_started_at(&self) -> &Option<DateTime>
A timestamp of when audio aggregation started for this authentication result.
Sourcepub fn audio_aggregation_ended_at(self, input: DateTime) -> Self
pub fn audio_aggregation_ended_at(self, input: DateTime) -> Self
A timestamp of when audio aggregation ended for this authentication result.
Sourcepub fn set_audio_aggregation_ended_at(self, input: Option<DateTime>) -> Self
pub fn set_audio_aggregation_ended_at(self, input: Option<DateTime>) -> Self
A timestamp of when audio aggregation ended for this authentication result.
Sourcepub fn get_audio_aggregation_ended_at(&self) -> &Option<DateTime>
pub fn get_audio_aggregation_ended_at(&self) -> &Option<DateTime>
A timestamp of when audio aggregation ended for this authentication result.
Sourcepub fn customer_speaker_id(self, input: impl Into<String>) -> Self
pub fn customer_speaker_id(self, input: impl Into<String>) -> Self
The client-provided identifier for the speaker whose authentication result is produced. Only present if a SpeakerId
is provided for the session.
Sourcepub fn set_customer_speaker_id(self, input: Option<String>) -> Self
pub fn set_customer_speaker_id(self, input: Option<String>) -> Self
The client-provided identifier for the speaker whose authentication result is produced. Only present if a SpeakerId
is provided for the session.
Sourcepub fn get_customer_speaker_id(&self) -> &Option<String>
pub fn get_customer_speaker_id(&self) -> &Option<String>
The client-provided identifier for the speaker whose authentication result is produced. Only present if a SpeakerId
is provided for the session.
Sourcepub fn generated_speaker_id(self, input: impl Into<String>) -> Self
pub fn generated_speaker_id(self, input: impl Into<String>) -> Self
The service-generated identifier for the speaker whose authentication result is produced.
Sourcepub fn set_generated_speaker_id(self, input: Option<String>) -> Self
pub fn set_generated_speaker_id(self, input: Option<String>) -> Self
The service-generated identifier for the speaker whose authentication result is produced.
Sourcepub fn get_generated_speaker_id(&self) -> &Option<String>
pub fn get_generated_speaker_id(&self) -> &Option<String>
The service-generated identifier for the speaker whose authentication result is produced.
Sourcepub fn decision(self, input: AuthenticationDecision) -> Self
pub fn decision(self, input: AuthenticationDecision) -> Self
The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
Sourcepub fn set_decision(self, input: Option<AuthenticationDecision>) -> Self
pub fn set_decision(self, input: Option<AuthenticationDecision>) -> Self
The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
Sourcepub fn get_decision(&self) -> &Option<AuthenticationDecision>
pub fn get_decision(&self) -> &Option<AuthenticationDecision>
The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
Sourcepub fn score(self, input: i32) -> Self
pub fn score(self, input: i32) -> Self
The authentication score for the speaker whose authentication result is produced. This value is only present if the authentication decision is either ACCEPT
or REJECT
.
Sourcepub fn set_score(self, input: Option<i32>) -> Self
pub fn set_score(self, input: Option<i32>) -> Self
The authentication score for the speaker whose authentication result is produced. This value is only present if the authentication decision is either ACCEPT
or REJECT
.
Sourcepub fn get_score(&self) -> &Option<i32>
pub fn get_score(&self) -> &Option<i32>
The authentication score for the speaker whose authentication result is produced. This value is only present if the authentication decision is either ACCEPT
or REJECT
.
Sourcepub fn configuration(self, input: AuthenticationConfiguration) -> Self
pub fn configuration(self, input: AuthenticationConfiguration) -> Self
The AuthenticationConfiguration
used to generate this authentication result.
Sourcepub fn set_configuration(
self,
input: Option<AuthenticationConfiguration>,
) -> Self
pub fn set_configuration( self, input: Option<AuthenticationConfiguration>, ) -> Self
The AuthenticationConfiguration
used to generate this authentication result.
Sourcepub fn get_configuration(&self) -> &Option<AuthenticationConfiguration>
pub fn get_configuration(&self) -> &Option<AuthenticationConfiguration>
The AuthenticationConfiguration
used to generate this authentication result.
Sourcepub fn build(self) -> AuthenticationResult
pub fn build(self) -> AuthenticationResult
Consumes the builder and constructs a AuthenticationResult
.
Trait Implementations§
Source§impl Clone for AuthenticationResultBuilder
impl Clone for AuthenticationResultBuilder
Source§fn clone(&self) -> AuthenticationResultBuilder
fn clone(&self) -> AuthenticationResultBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for AuthenticationResultBuilder
impl Debug for AuthenticationResultBuilder
Source§impl Default for AuthenticationResultBuilder
impl Default for AuthenticationResultBuilder
Source§fn default() -> AuthenticationResultBuilder
fn default() -> AuthenticationResultBuilder
impl StructuralPartialEq for AuthenticationResultBuilder
Auto Trait Implementations§
impl Freeze for AuthenticationResultBuilder
impl RefUnwindSafe for AuthenticationResultBuilder
impl Send for AuthenticationResultBuilder
impl Sync for AuthenticationResultBuilder
impl Unpin for AuthenticationResultBuilder
impl UnwindSafe for AuthenticationResultBuilder
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);