#[non_exhaustive]pub struct FailureConditionsBuilder { /* private fields */ }
Expand description
A builder for FailureConditions
.
Implementations§
Source§impl FailureConditionsBuilder
impl FailureConditionsBuilder
Sourcepub fn result(self, input: Result) -> Self
pub fn result(self, input: Result) -> Self
The specified result for when the failure conditions are met, such as rolling back the stage.
Sourcepub fn set_result(self, input: Option<Result>) -> Self
pub fn set_result(self, input: Option<Result>) -> Self
The specified result for when the failure conditions are met, such as rolling back the stage.
Sourcepub fn get_result(&self) -> &Option<Result>
pub fn get_result(&self) -> &Option<Result>
The specified result for when the failure conditions are met, such as rolling back the stage.
Sourcepub fn retry_configuration(self, input: RetryConfiguration) -> Self
pub fn retry_configuration(self, input: RetryConfiguration) -> Self
The retry configuration specifies automatic retry for a failed stage, along with the configured retry mode.
Sourcepub fn set_retry_configuration(self, input: Option<RetryConfiguration>) -> Self
pub fn set_retry_configuration(self, input: Option<RetryConfiguration>) -> Self
The retry configuration specifies automatic retry for a failed stage, along with the configured retry mode.
Sourcepub fn get_retry_configuration(&self) -> &Option<RetryConfiguration>
pub fn get_retry_configuration(&self) -> &Option<RetryConfiguration>
The retry configuration specifies automatic retry for a failed stage, along with the configured retry mode.
Sourcepub fn conditions(self, input: Condition) -> Self
pub fn conditions(self, input: Condition) -> Self
Appends an item to conditions
.
To override the contents of this collection use set_conditions
.
The conditions that are configured as failure conditions. For more information about conditions, see Stage conditions and How do stage conditions work?.
Sourcepub fn set_conditions(self, input: Option<Vec<Condition>>) -> Self
pub fn set_conditions(self, input: Option<Vec<Condition>>) -> Self
The conditions that are configured as failure conditions. For more information about conditions, see Stage conditions and How do stage conditions work?.
Sourcepub fn get_conditions(&self) -> &Option<Vec<Condition>>
pub fn get_conditions(&self) -> &Option<Vec<Condition>>
The conditions that are configured as failure conditions. For more information about conditions, see Stage conditions and How do stage conditions work?.
Sourcepub fn build(self) -> FailureConditions
pub fn build(self) -> FailureConditions
Consumes the builder and constructs a FailureConditions
.
Trait Implementations§
Source§impl Clone for FailureConditionsBuilder
impl Clone for FailureConditionsBuilder
Source§fn clone(&self) -> FailureConditionsBuilder
fn clone(&self) -> FailureConditionsBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for FailureConditionsBuilder
impl Debug for FailureConditionsBuilder
Source§impl Default for FailureConditionsBuilder
impl Default for FailureConditionsBuilder
Source§fn default() -> FailureConditionsBuilder
fn default() -> FailureConditionsBuilder
Source§impl PartialEq for FailureConditionsBuilder
impl PartialEq for FailureConditionsBuilder
impl StructuralPartialEq for FailureConditionsBuilder
Auto Trait Implementations§
impl Freeze for FailureConditionsBuilder
impl RefUnwindSafe for FailureConditionsBuilder
impl Send for FailureConditionsBuilder
impl Sync for FailureConditionsBuilder
impl Unpin for FailureConditionsBuilder
impl UnwindSafe for FailureConditionsBuilder
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);