#[non_exhaustive]pub struct ConditionalSpecificationBuilder { /* private fields */ }Expand description
A builder for ConditionalSpecification.
Implementations§
Source§impl ConditionalSpecificationBuilder
impl ConditionalSpecificationBuilder
Sourcepub fn active(self, input: bool) -> Self
pub fn active(self, input: bool) -> Self
Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.
Sourcepub fn set_active(self, input: Option<bool>) -> Self
pub fn set_active(self, input: Option<bool>) -> Self
Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.
Sourcepub fn get_active(&self) -> &Option<bool>
pub fn get_active(&self) -> &Option<bool>
Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.
Sourcepub fn conditional_branches(self, input: ConditionalBranch) -> Self
pub fn conditional_branches(self, input: ConditionalBranch) -> Self
Appends an item to conditional_branches.
To override the contents of this collection use set_conditional_branches.
A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
Sourcepub fn set_conditional_branches(
self,
input: Option<Vec<ConditionalBranch>>,
) -> Self
pub fn set_conditional_branches( self, input: Option<Vec<ConditionalBranch>>, ) -> Self
A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
Sourcepub fn get_conditional_branches(&self) -> &Option<Vec<ConditionalBranch>>
pub fn get_conditional_branches(&self) -> &Option<Vec<ConditionalBranch>>
A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
Sourcepub fn default_branch(self, input: DefaultConditionalBranch) -> Self
pub fn default_branch(self, input: DefaultConditionalBranch) -> Self
The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
This field is required.Sourcepub fn set_default_branch(self, input: Option<DefaultConditionalBranch>) -> Self
pub fn set_default_branch(self, input: Option<DefaultConditionalBranch>) -> Self
The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
Sourcepub fn get_default_branch(&self) -> &Option<DefaultConditionalBranch>
pub fn get_default_branch(&self) -> &Option<DefaultConditionalBranch>
The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
Sourcepub fn build(self) -> Result<ConditionalSpecification, BuildError>
pub fn build(self) -> Result<ConditionalSpecification, BuildError>
Consumes the builder and constructs a ConditionalSpecification.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for ConditionalSpecificationBuilder
impl Clone for ConditionalSpecificationBuilder
Source§fn clone(&self) -> ConditionalSpecificationBuilder
fn clone(&self) -> ConditionalSpecificationBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Default for ConditionalSpecificationBuilder
impl Default for ConditionalSpecificationBuilder
Source§fn default() -> ConditionalSpecificationBuilder
fn default() -> ConditionalSpecificationBuilder
Source§impl PartialEq for ConditionalSpecificationBuilder
impl PartialEq for ConditionalSpecificationBuilder
Source§fn eq(&self, other: &ConditionalSpecificationBuilder) -> bool
fn eq(&self, other: &ConditionalSpecificationBuilder) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for ConditionalSpecificationBuilder
Auto Trait Implementations§
impl Freeze for ConditionalSpecificationBuilder
impl RefUnwindSafe for ConditionalSpecificationBuilder
impl Send for ConditionalSpecificationBuilder
impl Sync for ConditionalSpecificationBuilder
impl Unpin for ConditionalSpecificationBuilder
impl UnwindSafe for ConditionalSpecificationBuilder
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);