#[non_exhaustive]pub struct StepStatusBuilder { /* private fields */ }
Expand description
A builder for StepStatus
.
Implementations§
Source§impl StepStatusBuilder
impl StepStatusBuilder
Sourcepub fn set_state(self, input: Option<StepState>) -> Self
pub fn set_state(self, input: Option<StepState>) -> Self
The execution state of the cluster step.
Sourcepub fn state_change_reason(self, input: StepStateChangeReason) -> Self
pub fn state_change_reason(self, input: StepStateChangeReason) -> Self
The reason for the step execution status change.
Sourcepub fn set_state_change_reason(
self,
input: Option<StepStateChangeReason>,
) -> Self
pub fn set_state_change_reason( self, input: Option<StepStateChangeReason>, ) -> Self
The reason for the step execution status change.
Sourcepub fn get_state_change_reason(&self) -> &Option<StepStateChangeReason>
pub fn get_state_change_reason(&self) -> &Option<StepStateChangeReason>
The reason for the step execution status change.
Sourcepub fn failure_details(self, input: FailureDetails) -> Self
pub fn failure_details(self, input: FailureDetails) -> Self
The details for the step failure including reason, message, and log file path where the root cause was identified.
Sourcepub fn set_failure_details(self, input: Option<FailureDetails>) -> Self
pub fn set_failure_details(self, input: Option<FailureDetails>) -> Self
The details for the step failure including reason, message, and log file path where the root cause was identified.
Sourcepub fn get_failure_details(&self) -> &Option<FailureDetails>
pub fn get_failure_details(&self) -> &Option<FailureDetails>
The details for the step failure including reason, message, and log file path where the root cause was identified.
Sourcepub fn timeline(self, input: StepTimeline) -> Self
pub fn timeline(self, input: StepTimeline) -> Self
The timeline of the cluster step status over time.
Sourcepub fn set_timeline(self, input: Option<StepTimeline>) -> Self
pub fn set_timeline(self, input: Option<StepTimeline>) -> Self
The timeline of the cluster step status over time.
Sourcepub fn get_timeline(&self) -> &Option<StepTimeline>
pub fn get_timeline(&self) -> &Option<StepTimeline>
The timeline of the cluster step status over time.
Sourcepub fn build(self) -> StepStatus
pub fn build(self) -> StepStatus
Consumes the builder and constructs a StepStatus
.
Trait Implementations§
Source§impl Clone for StepStatusBuilder
impl Clone for StepStatusBuilder
Source§fn clone(&self) -> StepStatusBuilder
fn clone(&self) -> StepStatusBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for StepStatusBuilder
impl Debug for StepStatusBuilder
Source§impl Default for StepStatusBuilder
impl Default for StepStatusBuilder
Source§fn default() -> StepStatusBuilder
fn default() -> StepStatusBuilder
Source§impl PartialEq for StepStatusBuilder
impl PartialEq for StepStatusBuilder
impl StructuralPartialEq for StepStatusBuilder
Auto Trait Implementations§
impl Freeze for StepStatusBuilder
impl RefUnwindSafe for StepStatusBuilder
impl Send for StepStatusBuilder
impl Sync for StepStatusBuilder
impl Unpin for StepStatusBuilder
impl UnwindSafe for StepStatusBuilder
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);