#[non_exhaustive]pub struct BuildGroupBuilder { /* private fields */ }
Expand description
A builder for BuildGroup
.
Implementations§
Source§impl BuildGroupBuilder
impl BuildGroupBuilder
Sourcepub fn identifier(self, input: impl Into<String>) -> Self
pub fn identifier(self, input: impl Into<String>) -> Self
Contains the identifier of the build group.
Sourcepub fn set_identifier(self, input: Option<String>) -> Self
pub fn set_identifier(self, input: Option<String>) -> Self
Contains the identifier of the build group.
Sourcepub fn get_identifier(&self) -> &Option<String>
pub fn get_identifier(&self) -> &Option<String>
Contains the identifier of the build group.
Sourcepub fn depends_on(self, input: impl Into<String>) -> Self
pub fn depends_on(self, input: impl Into<String>) -> Self
Appends an item to depends_on
.
To override the contents of this collection use set_depends_on
.
An array of strings that contain the identifiers of the build groups that this build group depends on.
Sourcepub fn set_depends_on(self, input: Option<Vec<String>>) -> Self
pub fn set_depends_on(self, input: Option<Vec<String>>) -> Self
An array of strings that contain the identifiers of the build groups that this build group depends on.
Sourcepub fn get_depends_on(&self) -> &Option<Vec<String>>
pub fn get_depends_on(&self) -> &Option<Vec<String>>
An array of strings that contain the identifiers of the build groups that this build group depends on.
Sourcepub fn ignore_failure(self, input: bool) -> Self
pub fn ignore_failure(self, input: bool) -> Self
Specifies if failures in this build group can be ignored.
Sourcepub fn set_ignore_failure(self, input: Option<bool>) -> Self
pub fn set_ignore_failure(self, input: Option<bool>) -> Self
Specifies if failures in this build group can be ignored.
Sourcepub fn get_ignore_failure(&self) -> &Option<bool>
pub fn get_ignore_failure(&self) -> &Option<bool>
Specifies if failures in this build group can be ignored.
Sourcepub fn current_build_summary(self, input: BuildSummary) -> Self
pub fn current_build_summary(self, input: BuildSummary) -> Self
A BuildSummary
object that contains a summary of the current build group.
Sourcepub fn set_current_build_summary(self, input: Option<BuildSummary>) -> Self
pub fn set_current_build_summary(self, input: Option<BuildSummary>) -> Self
A BuildSummary
object that contains a summary of the current build group.
Sourcepub fn get_current_build_summary(&self) -> &Option<BuildSummary>
pub fn get_current_build_summary(&self) -> &Option<BuildSummary>
A BuildSummary
object that contains a summary of the current build group.
Sourcepub fn prior_build_summary_list(self, input: BuildSummary) -> Self
pub fn prior_build_summary_list(self, input: BuildSummary) -> Self
Appends an item to prior_build_summary_list
.
To override the contents of this collection use set_prior_build_summary_list
.
An array of BuildSummary
objects that contain summaries of previous build groups.
Sourcepub fn set_prior_build_summary_list(
self,
input: Option<Vec<BuildSummary>>,
) -> Self
pub fn set_prior_build_summary_list( self, input: Option<Vec<BuildSummary>>, ) -> Self
An array of BuildSummary
objects that contain summaries of previous build groups.
Sourcepub fn get_prior_build_summary_list(&self) -> &Option<Vec<BuildSummary>>
pub fn get_prior_build_summary_list(&self) -> &Option<Vec<BuildSummary>>
An array of BuildSummary
objects that contain summaries of previous build groups.
Sourcepub fn build(self) -> BuildGroup
pub fn build(self) -> BuildGroup
Consumes the builder and constructs a BuildGroup
.
Trait Implementations§
Source§impl Clone for BuildGroupBuilder
impl Clone for BuildGroupBuilder
Source§fn clone(&self) -> BuildGroupBuilder
fn clone(&self) -> BuildGroupBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for BuildGroupBuilder
impl Debug for BuildGroupBuilder
Source§impl Default for BuildGroupBuilder
impl Default for BuildGroupBuilder
Source§fn default() -> BuildGroupBuilder
fn default() -> BuildGroupBuilder
Source§impl PartialEq for BuildGroupBuilder
impl PartialEq for BuildGroupBuilder
impl StructuralPartialEq for BuildGroupBuilder
Auto Trait Implementations§
impl Freeze for BuildGroupBuilder
impl RefUnwindSafe for BuildGroupBuilder
impl Send for BuildGroupBuilder
impl Sync for BuildGroupBuilder
impl Unpin for BuildGroupBuilder
impl UnwindSafe for BuildGroupBuilder
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);