#[non_exhaustive]pub struct PromptSpecificationBuilder { /* private fields */ }
Expand description
A builder for PromptSpecification
.
Implementations§
Source§impl PromptSpecificationBuilder
impl PromptSpecificationBuilder
Sourcepub fn message_groups(self, input: MessageGroup) -> Self
pub fn message_groups(self, input: MessageGroup) -> Self
Appends an item to message_groups
.
To override the contents of this collection use set_message_groups
.
A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
Sourcepub fn set_message_groups(self, input: Option<Vec<MessageGroup>>) -> Self
pub fn set_message_groups(self, input: Option<Vec<MessageGroup>>) -> Self
A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
Sourcepub fn get_message_groups(&self) -> &Option<Vec<MessageGroup>>
pub fn get_message_groups(&self) -> &Option<Vec<MessageGroup>>
A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
Sourcepub fn max_retries(self, input: i32) -> Self
pub fn max_retries(self, input: i32) -> Self
The maximum number of times the bot tries to elicit a response from the user using this prompt.
This field is required.Sourcepub fn set_max_retries(self, input: Option<i32>) -> Self
pub fn set_max_retries(self, input: Option<i32>) -> Self
The maximum number of times the bot tries to elicit a response from the user using this prompt.
Sourcepub fn get_max_retries(&self) -> &Option<i32>
pub fn get_max_retries(&self) -> &Option<i32>
The maximum number of times the bot tries to elicit a response from the user using this prompt.
Sourcepub fn allow_interrupt(self, input: bool) -> Self
pub fn allow_interrupt(self, input: bool) -> Self
Indicates whether the user can interrupt a speech prompt from the bot.
Sourcepub fn set_allow_interrupt(self, input: Option<bool>) -> Self
pub fn set_allow_interrupt(self, input: Option<bool>) -> Self
Indicates whether the user can interrupt a speech prompt from the bot.
Sourcepub fn get_allow_interrupt(&self) -> &Option<bool>
pub fn get_allow_interrupt(&self) -> &Option<bool>
Indicates whether the user can interrupt a speech prompt from the bot.
Sourcepub fn message_selection_strategy(self, input: MessageSelectionStrategy) -> Self
pub fn message_selection_strategy(self, input: MessageSelectionStrategy) -> Self
Indicates how a message is selected from a message group among retries.
Sourcepub fn set_message_selection_strategy(
self,
input: Option<MessageSelectionStrategy>,
) -> Self
pub fn set_message_selection_strategy( self, input: Option<MessageSelectionStrategy>, ) -> Self
Indicates how a message is selected from a message group among retries.
Sourcepub fn get_message_selection_strategy(
&self,
) -> &Option<MessageSelectionStrategy>
pub fn get_message_selection_strategy( &self, ) -> &Option<MessageSelectionStrategy>
Indicates how a message is selected from a message group among retries.
Sourcepub fn prompt_attempts_specification(
self,
k: PromptAttempt,
v: PromptAttemptSpecification,
) -> Self
pub fn prompt_attempts_specification( self, k: PromptAttempt, v: PromptAttemptSpecification, ) -> Self
Adds a key-value pair to prompt_attempts_specification
.
To override the contents of this collection use set_prompt_attempts_specification
.
Specifies the advanced settings on each attempt of the prompt.
Sourcepub fn set_prompt_attempts_specification(
self,
input: Option<HashMap<PromptAttempt, PromptAttemptSpecification>>,
) -> Self
pub fn set_prompt_attempts_specification( self, input: Option<HashMap<PromptAttempt, PromptAttemptSpecification>>, ) -> Self
Specifies the advanced settings on each attempt of the prompt.
Sourcepub fn get_prompt_attempts_specification(
&self,
) -> &Option<HashMap<PromptAttempt, PromptAttemptSpecification>>
pub fn get_prompt_attempts_specification( &self, ) -> &Option<HashMap<PromptAttempt, PromptAttemptSpecification>>
Specifies the advanced settings on each attempt of the prompt.
Sourcepub fn build(self) -> Result<PromptSpecification, BuildError>
pub fn build(self) -> Result<PromptSpecification, BuildError>
Consumes the builder and constructs a PromptSpecification
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for PromptSpecificationBuilder
impl Clone for PromptSpecificationBuilder
Source§fn clone(&self) -> PromptSpecificationBuilder
fn clone(&self) -> PromptSpecificationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for PromptSpecificationBuilder
impl Debug for PromptSpecificationBuilder
Source§impl Default for PromptSpecificationBuilder
impl Default for PromptSpecificationBuilder
Source§fn default() -> PromptSpecificationBuilder
fn default() -> PromptSpecificationBuilder
impl StructuralPartialEq for PromptSpecificationBuilder
Auto Trait Implementations§
impl Freeze for PromptSpecificationBuilder
impl RefUnwindSafe for PromptSpecificationBuilder
impl Send for PromptSpecificationBuilder
impl Sync for PromptSpecificationBuilder
impl Unpin for PromptSpecificationBuilder
impl UnwindSafe for PromptSpecificationBuilder
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);