#[non_exhaustive]pub struct DialogActionBuilder { /* private fields */ }
Expand description
A builder for DialogAction
.
Implementations§
Source§impl DialogActionBuilder
impl DialogActionBuilder
Sourcepub fn type(self, input: DialogActionType) -> Self
pub fn type(self, input: DialogActionType) -> Self
The next action that the bot should take in its interaction with the user. The possible values are:
-
ConfirmIntent
- The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?" -
Close
- Indicates that the there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response. -
Delegate
- The next action is determined by Amazon Lex. -
ElicitIntent
- The next action is to determine the intent that the user wants to fulfill. -
ElicitSlot
- The next action is to elicit a slot value from the user.
Sourcepub fn set_type(self, input: Option<DialogActionType>) -> Self
pub fn set_type(self, input: Option<DialogActionType>) -> Self
The next action that the bot should take in its interaction with the user. The possible values are:
-
ConfirmIntent
- The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?" -
Close
- Indicates that the there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response. -
Delegate
- The next action is determined by Amazon Lex. -
ElicitIntent
- The next action is to determine the intent that the user wants to fulfill. -
ElicitSlot
- The next action is to elicit a slot value from the user.
Sourcepub fn get_type(&self) -> &Option<DialogActionType>
pub fn get_type(&self) -> &Option<DialogActionType>
The next action that the bot should take in its interaction with the user. The possible values are:
-
ConfirmIntent
- The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?" -
Close
- Indicates that the there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response. -
Delegate
- The next action is determined by Amazon Lex. -
ElicitIntent
- The next action is to determine the intent that the user wants to fulfill. -
ElicitSlot
- The next action is to elicit a slot value from the user.
Sourcepub fn intent_name(self, input: impl Into<String>) -> Self
pub fn intent_name(self, input: impl Into<String>) -> Self
The name of the intent.
Sourcepub fn set_intent_name(self, input: Option<String>) -> Self
pub fn set_intent_name(self, input: Option<String>) -> Self
The name of the intent.
Sourcepub fn get_intent_name(&self) -> &Option<String>
pub fn get_intent_name(&self) -> &Option<String>
The name of the intent.
Sourcepub fn slots(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn slots(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to slots
.
To override the contents of this collection use set_slots
.
Map of the slots that have been gathered and their values.
Sourcepub fn set_slots(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_slots(self, input: Option<HashMap<String, String>>) -> Self
Map of the slots that have been gathered and their values.
Sourcepub fn get_slots(&self) -> &Option<HashMap<String, String>>
pub fn get_slots(&self) -> &Option<HashMap<String, String>>
Map of the slots that have been gathered and their values.
Sourcepub fn slot_to_elicit(self, input: impl Into<String>) -> Self
pub fn slot_to_elicit(self, input: impl Into<String>) -> Self
The name of the slot that should be elicited from the user.
Sourcepub fn set_slot_to_elicit(self, input: Option<String>) -> Self
pub fn set_slot_to_elicit(self, input: Option<String>) -> Self
The name of the slot that should be elicited from the user.
Sourcepub fn get_slot_to_elicit(&self) -> &Option<String>
pub fn get_slot_to_elicit(&self) -> &Option<String>
The name of the slot that should be elicited from the user.
Sourcepub fn fulfillment_state(self, input: FulfillmentState) -> Self
pub fn fulfillment_state(self, input: FulfillmentState) -> Self
The fulfillment state of the intent. The possible values are:
-
Failed
- The Lambda function associated with the intent failed to fulfill the intent. -
Fulfilled
- The intent has fulfilled by the Lambda function associated with the intent. -
ReadyForFulfillment
- All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.
Sourcepub fn set_fulfillment_state(self, input: Option<FulfillmentState>) -> Self
pub fn set_fulfillment_state(self, input: Option<FulfillmentState>) -> Self
The fulfillment state of the intent. The possible values are:
-
Failed
- The Lambda function associated with the intent failed to fulfill the intent. -
Fulfilled
- The intent has fulfilled by the Lambda function associated with the intent. -
ReadyForFulfillment
- All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.
Sourcepub fn get_fulfillment_state(&self) -> &Option<FulfillmentState>
pub fn get_fulfillment_state(&self) -> &Option<FulfillmentState>
The fulfillment state of the intent. The possible values are:
-
Failed
- The Lambda function associated with the intent failed to fulfill the intent. -
Fulfilled
- The intent has fulfilled by the Lambda function associated with the intent. -
ReadyForFulfillment
- All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.
Sourcepub fn message(self, input: impl Into<String>) -> Self
pub fn message(self, input: impl Into<String>) -> Self
The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the message configured for the intent.
Sourcepub fn set_message(self, input: Option<String>) -> Self
pub fn set_message(self, input: Option<String>) -> Self
The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the message configured for the intent.
Sourcepub fn get_message(&self) -> &Option<String>
pub fn get_message(&self) -> &Option<String>
The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the message configured for the intent.
Sourcepub fn message_format(self, input: MessageFormatType) -> Self
pub fn message_format(self, input: MessageFormatType) -> Self
-
PlainText
- The message contains plain UTF-8 text. -
CustomPayload
- The message is a custom format for the client. -
SSML
- The message contains text formatted for voice output. -
Composite
- The message contains an escaped JSON object containing one or more messages. For more information, see Message Groups.
Sourcepub fn set_message_format(self, input: Option<MessageFormatType>) -> Self
pub fn set_message_format(self, input: Option<MessageFormatType>) -> Self
-
PlainText
- The message contains plain UTF-8 text. -
CustomPayload
- The message is a custom format for the client. -
SSML
- The message contains text formatted for voice output. -
Composite
- The message contains an escaped JSON object containing one or more messages. For more information, see Message Groups.
Sourcepub fn get_message_format(&self) -> &Option<MessageFormatType>
pub fn get_message_format(&self) -> &Option<MessageFormatType>
-
PlainText
- The message contains plain UTF-8 text. -
CustomPayload
- The message is a custom format for the client. -
SSML
- The message contains text formatted for voice output. -
Composite
- The message contains an escaped JSON object containing one or more messages. For more information, see Message Groups.
Sourcepub fn build(self) -> Result<DialogAction, BuildError>
pub fn build(self) -> Result<DialogAction, BuildError>
Consumes the builder and constructs a DialogAction
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for DialogActionBuilder
impl Clone for DialogActionBuilder
Source§fn clone(&self) -> DialogActionBuilder
fn clone(&self) -> DialogActionBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DialogActionBuilder
impl Debug for DialogActionBuilder
Source§impl Default for DialogActionBuilder
impl Default for DialogActionBuilder
Source§fn default() -> DialogActionBuilder
fn default() -> DialogActionBuilder
Source§impl PartialEq for DialogActionBuilder
impl PartialEq for DialogActionBuilder
impl StructuralPartialEq for DialogActionBuilder
Auto Trait Implementations§
impl Freeze for DialogActionBuilder
impl RefUnwindSafe for DialogActionBuilder
impl Send for DialogActionBuilder
impl Sync for DialogActionBuilder
impl Unpin for DialogActionBuilder
impl UnwindSafe for DialogActionBuilder
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);