#[non_exhaustive]pub struct HookProgressEventBuilder { /* private fields */ }
Expand description
A builder for HookProgressEvent
.
Implementations§
Source§impl HookProgressEventBuilder
impl HookProgressEventBuilder
Sourcepub fn hook_type_name(self, input: impl Into<String>) -> Self
pub fn hook_type_name(self, input: impl Into<String>) -> Self
The type name of the Hook being invoked.
Sourcepub fn set_hook_type_name(self, input: Option<String>) -> Self
pub fn set_hook_type_name(self, input: Option<String>) -> Self
The type name of the Hook being invoked.
Sourcepub fn get_hook_type_name(&self) -> &Option<String>
pub fn get_hook_type_name(&self) -> &Option<String>
The type name of the Hook being invoked.
Sourcepub fn hook_type_version_id(self, input: impl Into<String>) -> Self
pub fn hook_type_version_id(self, input: impl Into<String>) -> Self
The type version of the Hook being invoked.
Sourcepub fn set_hook_type_version_id(self, input: Option<String>) -> Self
pub fn set_hook_type_version_id(self, input: Option<String>) -> Self
The type version of the Hook being invoked.
Sourcepub fn get_hook_type_version_id(&self) -> &Option<String>
pub fn get_hook_type_version_id(&self) -> &Option<String>
The type version of the Hook being invoked.
Sourcepub fn hook_type_arn(self, input: impl Into<String>) -> Self
pub fn hook_type_arn(self, input: impl Into<String>) -> Self
The ARN of the Hook being invoked.
Sourcepub fn set_hook_type_arn(self, input: Option<String>) -> Self
pub fn set_hook_type_arn(self, input: Option<String>) -> Self
The ARN of the Hook being invoked.
Sourcepub fn get_hook_type_arn(&self) -> &Option<String>
pub fn get_hook_type_arn(&self) -> &Option<String>
The ARN of the Hook being invoked.
Sourcepub fn invocation_point(self, input: impl Into<String>) -> Self
pub fn invocation_point(self, input: impl Into<String>) -> Self
States whether the Hook is invoked before or after resource provisioning.
Sourcepub fn set_invocation_point(self, input: Option<String>) -> Self
pub fn set_invocation_point(self, input: Option<String>) -> Self
States whether the Hook is invoked before or after resource provisioning.
Sourcepub fn get_invocation_point(&self) -> &Option<String>
pub fn get_invocation_point(&self) -> &Option<String>
States whether the Hook is invoked before or after resource provisioning.
Sourcepub fn hook_status(self, input: impl Into<String>) -> Self
pub fn hook_status(self, input: impl Into<String>) -> Self
The status of the Hook invocation. The following are potential statuses:
-
HOOK_PENDING
: The Hook was added to the invocation plan, but not yet invoked. -
HOOK_IN_PROGRESS
: The Hook was invoked, but hasn't completed. -
HOOK_COMPLETE_SUCCEEDED
: The Hook invocation is complete with a successful result. -
HOOK_COMPLETE_FAILED
: The Hook invocation is complete with a failed result. -
HOOK_FAILED
: The Hook invocation didn't complete successfully.
Sourcepub fn set_hook_status(self, input: Option<String>) -> Self
pub fn set_hook_status(self, input: Option<String>) -> Self
The status of the Hook invocation. The following are potential statuses:
-
HOOK_PENDING
: The Hook was added to the invocation plan, but not yet invoked. -
HOOK_IN_PROGRESS
: The Hook was invoked, but hasn't completed. -
HOOK_COMPLETE_SUCCEEDED
: The Hook invocation is complete with a successful result. -
HOOK_COMPLETE_FAILED
: The Hook invocation is complete with a failed result. -
HOOK_FAILED
: The Hook invocation didn't complete successfully.
Sourcepub fn get_hook_status(&self) -> &Option<String>
pub fn get_hook_status(&self) -> &Option<String>
The status of the Hook invocation. The following are potential statuses:
-
HOOK_PENDING
: The Hook was added to the invocation plan, but not yet invoked. -
HOOK_IN_PROGRESS
: The Hook was invoked, but hasn't completed. -
HOOK_COMPLETE_SUCCEEDED
: The Hook invocation is complete with a successful result. -
HOOK_COMPLETE_FAILED
: The Hook invocation is complete with a failed result. -
HOOK_FAILED
: The Hook invocation didn't complete successfully.
Sourcepub fn hook_event_time(self, input: DateTime) -> Self
pub fn hook_event_time(self, input: DateTime) -> Self
The time that the Hook invocation request initiated.
Sourcepub fn set_hook_event_time(self, input: Option<DateTime>) -> Self
pub fn set_hook_event_time(self, input: Option<DateTime>) -> Self
The time that the Hook invocation request initiated.
Sourcepub fn get_hook_event_time(&self) -> &Option<DateTime>
pub fn get_hook_event_time(&self) -> &Option<DateTime>
The time that the Hook invocation request initiated.
Sourcepub fn hook_status_message(self, input: impl Into<String>) -> Self
pub fn hook_status_message(self, input: impl Into<String>) -> Self
The message explaining the current Hook status.
Sourcepub fn set_hook_status_message(self, input: Option<String>) -> Self
pub fn set_hook_status_message(self, input: Option<String>) -> Self
The message explaining the current Hook status.
Sourcepub fn get_hook_status_message(&self) -> &Option<String>
pub fn get_hook_status_message(&self) -> &Option<String>
The message explaining the current Hook status.
Sourcepub fn failure_mode(self, input: impl Into<String>) -> Self
pub fn failure_mode(self, input: impl Into<String>) -> Self
The failure mode of the invocation. The following are the potential statuses:
-
FAIL
: This will fail the Hook invocation and the request associated with it. -
WARN
: This will fail the Hook invocation, but not the request associated with it.
Sourcepub fn set_failure_mode(self, input: Option<String>) -> Self
pub fn set_failure_mode(self, input: Option<String>) -> Self
The failure mode of the invocation. The following are the potential statuses:
-
FAIL
: This will fail the Hook invocation and the request associated with it. -
WARN
: This will fail the Hook invocation, but not the request associated with it.
Sourcepub fn get_failure_mode(&self) -> &Option<String>
pub fn get_failure_mode(&self) -> &Option<String>
The failure mode of the invocation. The following are the potential statuses:
-
FAIL
: This will fail the Hook invocation and the request associated with it. -
WARN
: This will fail the Hook invocation, but not the request associated with it.
Sourcepub fn build(self) -> HookProgressEvent
pub fn build(self) -> HookProgressEvent
Consumes the builder and constructs a HookProgressEvent
.
Trait Implementations§
Source§impl Clone for HookProgressEventBuilder
impl Clone for HookProgressEventBuilder
Source§fn clone(&self) -> HookProgressEventBuilder
fn clone(&self) -> HookProgressEventBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for HookProgressEventBuilder
impl Debug for HookProgressEventBuilder
Source§impl Default for HookProgressEventBuilder
impl Default for HookProgressEventBuilder
Source§fn default() -> HookProgressEventBuilder
fn default() -> HookProgressEventBuilder
Source§impl PartialEq for HookProgressEventBuilder
impl PartialEq for HookProgressEventBuilder
impl StructuralPartialEq for HookProgressEventBuilder
Auto Trait Implementations§
impl Freeze for HookProgressEventBuilder
impl RefUnwindSafe for HookProgressEventBuilder
impl Send for HookProgressEventBuilder
impl Sync for HookProgressEventBuilder
impl Unpin for HookProgressEventBuilder
impl UnwindSafe for HookProgressEventBuilder
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);