#[non_exhaustive]pub struct OperationEventBuilder { /* private fields */ }
Expand description
A builder for OperationEvent
.
Implementations§
Source§impl OperationEventBuilder
impl OperationEventBuilder
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description of the operation event. For example, "Stop the EC2 instance i-abcdefgh987654321".
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description of the operation event. For example, "Stop the EC2 instance i-abcdefgh987654321".
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description of the operation event. For example, "Stop the EC2 instance i-abcdefgh987654321".
Sourcepub fn resource(self, input: Resource) -> Self
pub fn resource(self, input: Resource) -> Self
The resource involved in the operations event.
Contains ResourceArn
ARN and ResourceType
.
Sourcepub fn set_resource(self, input: Option<Resource>) -> Self
pub fn set_resource(self, input: Option<Resource>) -> Self
The resource involved in the operations event.
Contains ResourceArn
ARN and ResourceType
.
Sourcepub fn get_resource(&self) -> &Option<Resource>
pub fn get_resource(&self) -> &Option<Resource>
The resource involved in the operations event.
Contains ResourceArn
ARN and ResourceType
.
Sourcepub fn status(self, input: OperationEventStatus) -> Self
pub fn status(self, input: OperationEventStatus) -> Self
The status of the operation event. The possible statuses are: IN_PROGRESS
, COMPLETED
, and FAILED
.
Sourcepub fn set_status(self, input: Option<OperationEventStatus>) -> Self
pub fn set_status(self, input: Option<OperationEventStatus>) -> Self
The status of the operation event. The possible statuses are: IN_PROGRESS
, COMPLETED
, and FAILED
.
Sourcepub fn get_status(&self) -> &Option<OperationEventStatus>
pub fn get_status(&self) -> &Option<OperationEventStatus>
The status of the operation event. The possible statuses are: IN_PROGRESS
, COMPLETED
, and FAILED
.
Sourcepub fn status_message(self, input: impl Into<String>) -> Self
pub fn status_message(self, input: impl Into<String>) -> Self
The status message relating to a specific operation event.
Sourcepub fn set_status_message(self, input: Option<String>) -> Self
pub fn set_status_message(self, input: Option<String>) -> Self
The status message relating to a specific operation event.
Sourcepub fn get_status_message(&self) -> &Option<String>
pub fn get_status_message(&self) -> &Option<String>
The status message relating to a specific operation event.
Sourcepub fn timestamp(self, input: DateTime) -> Self
pub fn timestamp(self, input: DateTime) -> Self
The timestamp of the specified operation event.
Sourcepub fn set_timestamp(self, input: Option<DateTime>) -> Self
pub fn set_timestamp(self, input: Option<DateTime>) -> Self
The timestamp of the specified operation event.
Sourcepub fn get_timestamp(&self) -> &Option<DateTime>
pub fn get_timestamp(&self) -> &Option<DateTime>
The timestamp of the specified operation event.
Sourcepub fn build(self) -> OperationEvent
pub fn build(self) -> OperationEvent
Consumes the builder and constructs a OperationEvent
.
Trait Implementations§
Source§impl Clone for OperationEventBuilder
impl Clone for OperationEventBuilder
Source§fn clone(&self) -> OperationEventBuilder
fn clone(&self) -> OperationEventBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for OperationEventBuilder
impl Debug for OperationEventBuilder
Source§impl Default for OperationEventBuilder
impl Default for OperationEventBuilder
Source§fn default() -> OperationEventBuilder
fn default() -> OperationEventBuilder
Source§impl PartialEq for OperationEventBuilder
impl PartialEq for OperationEventBuilder
impl StructuralPartialEq for OperationEventBuilder
Auto Trait Implementations§
impl Freeze for OperationEventBuilder
impl RefUnwindSafe for OperationEventBuilder
impl Send for OperationEventBuilder
impl Sync for OperationEventBuilder
impl Unpin for OperationEventBuilder
impl UnwindSafe for OperationEventBuilder
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);