#[non_exhaustive]pub struct PipelineContextBuilder { /* private fields */ }
Expand description
A builder for PipelineContext
.
Implementations§
Source§impl PipelineContextBuilder
impl PipelineContextBuilder
Sourcepub fn pipeline_name(self, input: impl Into<String>) -> Self
pub fn pipeline_name(self, input: impl Into<String>) -> Self
The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.
Sourcepub fn set_pipeline_name(self, input: Option<String>) -> Self
pub fn set_pipeline_name(self, input: Option<String>) -> Self
The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.
Sourcepub fn get_pipeline_name(&self) -> &Option<String>
pub fn get_pipeline_name(&self) -> &Option<String>
The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.
Sourcepub fn stage(self, input: StageContext) -> Self
pub fn stage(self, input: StageContext) -> Self
The stage of the pipeline.
Sourcepub fn set_stage(self, input: Option<StageContext>) -> Self
pub fn set_stage(self, input: Option<StageContext>) -> Self
The stage of the pipeline.
Sourcepub fn get_stage(&self) -> &Option<StageContext>
pub fn get_stage(&self) -> &Option<StageContext>
The stage of the pipeline.
Sourcepub fn action(self, input: ActionContext) -> Self
pub fn action(self, input: ActionContext) -> Self
The context of an action to a job worker in the stage of a pipeline.
Sourcepub fn set_action(self, input: Option<ActionContext>) -> Self
pub fn set_action(self, input: Option<ActionContext>) -> Self
The context of an action to a job worker in the stage of a pipeline.
Sourcepub fn get_action(&self) -> &Option<ActionContext>
pub fn get_action(&self) -> &Option<ActionContext>
The context of an action to a job worker in the stage of a pipeline.
Sourcepub fn pipeline_arn(self, input: impl Into<String>) -> Self
pub fn pipeline_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the pipeline.
Sourcepub fn set_pipeline_arn(self, input: Option<String>) -> Self
pub fn set_pipeline_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the pipeline.
Sourcepub fn get_pipeline_arn(&self) -> &Option<String>
pub fn get_pipeline_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the pipeline.
Sourcepub fn pipeline_execution_id(self, input: impl Into<String>) -> Self
pub fn pipeline_execution_id(self, input: impl Into<String>) -> Self
The execution ID of the pipeline.
Sourcepub fn set_pipeline_execution_id(self, input: Option<String>) -> Self
pub fn set_pipeline_execution_id(self, input: Option<String>) -> Self
The execution ID of the pipeline.
Sourcepub fn get_pipeline_execution_id(&self) -> &Option<String>
pub fn get_pipeline_execution_id(&self) -> &Option<String>
The execution ID of the pipeline.
Sourcepub fn build(self) -> PipelineContext
pub fn build(self) -> PipelineContext
Consumes the builder and constructs a PipelineContext
.
Trait Implementations§
Source§impl Clone for PipelineContextBuilder
impl Clone for PipelineContextBuilder
Source§fn clone(&self) -> PipelineContextBuilder
fn clone(&self) -> PipelineContextBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for PipelineContextBuilder
impl Debug for PipelineContextBuilder
Source§impl Default for PipelineContextBuilder
impl Default for PipelineContextBuilder
Source§fn default() -> PipelineContextBuilder
fn default() -> PipelineContextBuilder
Source§impl PartialEq for PipelineContextBuilder
impl PartialEq for PipelineContextBuilder
impl StructuralPartialEq for PipelineContextBuilder
Auto Trait Implementations§
impl Freeze for PipelineContextBuilder
impl RefUnwindSafe for PipelineContextBuilder
impl Send for PipelineContextBuilder
impl Sync for PipelineContextBuilder
impl Unpin for PipelineContextBuilder
impl UnwindSafe for PipelineContextBuilder
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);