#[non_exhaustive]pub struct FulfillmentUpdatesSpecification {
pub active: bool,
pub start_response: Option<FulfillmentStartResponseSpecification>,
pub update_response: Option<FulfillmentUpdateResponseSpecification>,
pub timeout_in_seconds: Option<i32>,
}
Expand description
Provides information for updating the user on the progress of fulfilling an intent.
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.active: bool
Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.
If the active
field is set to true, the startResponse
, updateResponse
, and timeoutInSeconds
fields are required.
start_response: Option<FulfillmentStartResponseSpecification>
Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.
update_response: Option<FulfillmentUpdateResponseSpecification>
Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.
timeout_in_seconds: Option<i32>
The length of time that the fulfillment Lambda function should run before it times out.
Implementations§
Source§impl FulfillmentUpdatesSpecification
impl FulfillmentUpdatesSpecification
Sourcepub fn active(&self) -> bool
pub fn active(&self) -> bool
Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.
If the active
field is set to true, the startResponse
, updateResponse
, and timeoutInSeconds
fields are required.
Sourcepub fn start_response(&self) -> Option<&FulfillmentStartResponseSpecification>
pub fn start_response(&self) -> Option<&FulfillmentStartResponseSpecification>
Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.
Sourcepub fn update_response(&self) -> Option<&FulfillmentUpdateResponseSpecification>
pub fn update_response(&self) -> Option<&FulfillmentUpdateResponseSpecification>
Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.
Sourcepub fn timeout_in_seconds(&self) -> Option<i32>
pub fn timeout_in_seconds(&self) -> Option<i32>
The length of time that the fulfillment Lambda function should run before it times out.
Source§impl FulfillmentUpdatesSpecification
impl FulfillmentUpdatesSpecification
Sourcepub fn builder() -> FulfillmentUpdatesSpecificationBuilder
pub fn builder() -> FulfillmentUpdatesSpecificationBuilder
Creates a new builder-style object to manufacture FulfillmentUpdatesSpecification
.
Trait Implementations§
Source§impl Clone for FulfillmentUpdatesSpecification
impl Clone for FulfillmentUpdatesSpecification
Source§fn clone(&self) -> FulfillmentUpdatesSpecification
fn clone(&self) -> FulfillmentUpdatesSpecification
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl PartialEq for FulfillmentUpdatesSpecification
impl PartialEq for FulfillmentUpdatesSpecification
Source§fn eq(&self, other: &FulfillmentUpdatesSpecification) -> bool
fn eq(&self, other: &FulfillmentUpdatesSpecification) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for FulfillmentUpdatesSpecification
Auto Trait Implementations§
impl Freeze for FulfillmentUpdatesSpecification
impl RefUnwindSafe for FulfillmentUpdatesSpecification
impl Send for FulfillmentUpdatesSpecification
impl Sync for FulfillmentUpdatesSpecification
impl Unpin for FulfillmentUpdatesSpecification
impl UnwindSafe for FulfillmentUpdatesSpecification
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);