#[non_exhaustive]pub struct ProgressEventBuilder { /* private fields */ }
Expand description
A builder for ProgressEvent
.
Implementations§
Source§impl ProgressEventBuilder
impl ProgressEventBuilder
Sourcepub fn type_name(self, input: impl Into<String>) -> Self
pub fn type_name(self, input: impl Into<String>) -> Self
The name of the resource type used in the operation.
Sourcepub fn set_type_name(self, input: Option<String>) -> Self
pub fn set_type_name(self, input: Option<String>) -> Self
The name of the resource type used in the operation.
Sourcepub fn get_type_name(&self) -> &Option<String>
pub fn get_type_name(&self) -> &Option<String>
The name of the resource type used in the operation.
Sourcepub fn identifier(self, input: impl Into<String>) -> Self
pub fn identifier(self, input: impl Into<String>) -> Self
The primary identifier for the resource.
In some cases, the resource identifier may be available before the resource operation has reached a status of SUCCESS
.
Sourcepub fn set_identifier(self, input: Option<String>) -> Self
pub fn set_identifier(self, input: Option<String>) -> Self
The primary identifier for the resource.
In some cases, the resource identifier may be available before the resource operation has reached a status of SUCCESS
.
Sourcepub fn get_identifier(&self) -> &Option<String>
pub fn get_identifier(&self) -> &Option<String>
The primary identifier for the resource.
In some cases, the resource identifier may be available before the resource operation has reached a status of SUCCESS
.
Sourcepub fn request_token(self, input: impl Into<String>) -> Self
pub fn request_token(self, input: impl Into<String>) -> Self
The unique token representing this resource operation request.
Use the RequestToken
with GetResourceRequestStatus to return the current status of a resource operation request.
Sourcepub fn set_request_token(self, input: Option<String>) -> Self
pub fn set_request_token(self, input: Option<String>) -> Self
The unique token representing this resource operation request.
Use the RequestToken
with GetResourceRequestStatus to return the current status of a resource operation request.
Sourcepub fn get_request_token(&self) -> &Option<String>
pub fn get_request_token(&self) -> &Option<String>
The unique token representing this resource operation request.
Use the RequestToken
with GetResourceRequestStatus to return the current status of a resource operation request.
Sourcepub fn hooks_request_token(self, input: impl Into<String>) -> Self
pub fn hooks_request_token(self, input: impl Into<String>) -> Self
The unique token representing the Hooks operation for the request.
Sourcepub fn set_hooks_request_token(self, input: Option<String>) -> Self
pub fn set_hooks_request_token(self, input: Option<String>) -> Self
The unique token representing the Hooks operation for the request.
Sourcepub fn get_hooks_request_token(&self) -> &Option<String>
pub fn get_hooks_request_token(&self) -> &Option<String>
The unique token representing the Hooks operation for the request.
Sourcepub fn set_operation(self, input: Option<Operation>) -> Self
pub fn set_operation(self, input: Option<Operation>) -> Self
The resource operation type.
Sourcepub fn get_operation(&self) -> &Option<Operation>
pub fn get_operation(&self) -> &Option<Operation>
The resource operation type.
Sourcepub fn operation_status(self, input: OperationStatus) -> Self
pub fn operation_status(self, input: OperationStatus) -> Self
The current status of the resource operation request.
-
PENDING
: The resource operation hasn't yet started. -
IN_PROGRESS
: The resource operation is currently in progress. -
SUCCESS
: The resource operation has successfully completed. -
FAILED
: The resource operation has failed. Refer to the error code and status message for more information. -
CANCEL_IN_PROGRESS
: The resource operation is in the process of being canceled. -
CANCEL_COMPLETE
: The resource operation has been canceled.
Sourcepub fn set_operation_status(self, input: Option<OperationStatus>) -> Self
pub fn set_operation_status(self, input: Option<OperationStatus>) -> Self
The current status of the resource operation request.
-
PENDING
: The resource operation hasn't yet started. -
IN_PROGRESS
: The resource operation is currently in progress. -
SUCCESS
: The resource operation has successfully completed. -
FAILED
: The resource operation has failed. Refer to the error code and status message for more information. -
CANCEL_IN_PROGRESS
: The resource operation is in the process of being canceled. -
CANCEL_COMPLETE
: The resource operation has been canceled.
Sourcepub fn get_operation_status(&self) -> &Option<OperationStatus>
pub fn get_operation_status(&self) -> &Option<OperationStatus>
The current status of the resource operation request.
-
PENDING
: The resource operation hasn't yet started. -
IN_PROGRESS
: The resource operation is currently in progress. -
SUCCESS
: The resource operation has successfully completed. -
FAILED
: The resource operation has failed. Refer to the error code and status message for more information. -
CANCEL_IN_PROGRESS
: The resource operation is in the process of being canceled. -
CANCEL_COMPLETE
: The resource operation has been canceled.
Sourcepub fn event_time(self, input: DateTime) -> Self
pub fn event_time(self, input: DateTime) -> Self
When the resource operation request was initiated.
Sourcepub fn set_event_time(self, input: Option<DateTime>) -> Self
pub fn set_event_time(self, input: Option<DateTime>) -> Self
When the resource operation request was initiated.
Sourcepub fn get_event_time(&self) -> &Option<DateTime>
pub fn get_event_time(&self) -> &Option<DateTime>
When the resource operation request was initiated.
Sourcepub fn resource_model(self, input: impl Into<String>) -> Self
pub fn resource_model(self, input: impl Into<String>) -> Self
A JSON string containing the resource model, consisting of each resource property and its current value.
Sourcepub fn set_resource_model(self, input: Option<String>) -> Self
pub fn set_resource_model(self, input: Option<String>) -> Self
A JSON string containing the resource model, consisting of each resource property and its current value.
Sourcepub fn get_resource_model(&self) -> &Option<String>
pub fn get_resource_model(&self) -> &Option<String>
A JSON string containing the resource model, consisting of each resource property and its current value.
Sourcepub fn status_message(self, input: impl Into<String>) -> Self
pub fn status_message(self, input: impl Into<String>) -> Self
Any message explaining the current status.
Sourcepub fn set_status_message(self, input: Option<String>) -> Self
pub fn set_status_message(self, input: Option<String>) -> Self
Any message explaining the current status.
Sourcepub fn get_status_message(&self) -> &Option<String>
pub fn get_status_message(&self) -> &Option<String>
Any message explaining the current status.
Sourcepub fn error_code(self, input: HandlerErrorCode) -> Self
pub fn error_code(self, input: HandlerErrorCode) -> Self
For requests with a status of FAILED
, the associated error code.
For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.
Sourcepub fn set_error_code(self, input: Option<HandlerErrorCode>) -> Self
pub fn set_error_code(self, input: Option<HandlerErrorCode>) -> Self
For requests with a status of FAILED
, the associated error code.
For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.
Sourcepub fn get_error_code(&self) -> &Option<HandlerErrorCode>
pub fn get_error_code(&self) -> &Option<HandlerErrorCode>
For requests with a status of FAILED
, the associated error code.
For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.
Sourcepub fn retry_after(self, input: DateTime) -> Self
pub fn retry_after(self, input: DateTime) -> Self
When to next request the status of this resource operation request.
Sourcepub fn set_retry_after(self, input: Option<DateTime>) -> Self
pub fn set_retry_after(self, input: Option<DateTime>) -> Self
When to next request the status of this resource operation request.
Sourcepub fn get_retry_after(&self) -> &Option<DateTime>
pub fn get_retry_after(&self) -> &Option<DateTime>
When to next request the status of this resource operation request.
Sourcepub fn build(self) -> ProgressEvent
pub fn build(self) -> ProgressEvent
Consumes the builder and constructs a ProgressEvent
.
Trait Implementations§
Source§impl Clone for ProgressEventBuilder
impl Clone for ProgressEventBuilder
Source§fn clone(&self) -> ProgressEventBuilder
fn clone(&self) -> ProgressEventBuilder
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 ProgressEventBuilder
impl Debug for ProgressEventBuilder
Source§impl Default for ProgressEventBuilder
impl Default for ProgressEventBuilder
Source§fn default() -> ProgressEventBuilder
fn default() -> ProgressEventBuilder
Source§impl PartialEq for ProgressEventBuilder
impl PartialEq for ProgressEventBuilder
impl StructuralPartialEq for ProgressEventBuilder
Auto Trait Implementations§
impl Freeze for ProgressEventBuilder
impl RefUnwindSafe for ProgressEventBuilder
impl Send for ProgressEventBuilder
impl Sync for ProgressEventBuilder
impl Unpin for ProgressEventBuilder
impl UnwindSafe for ProgressEventBuilder
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);