#[non_exhaustive]pub struct BuildPhaseBuilder { /* private fields */ }
Expand description
A builder for BuildPhase
.
Implementations§
Source§impl BuildPhaseBuilder
impl BuildPhaseBuilder
Sourcepub fn phase_type(self, input: BuildPhaseType) -> Self
pub fn phase_type(self, input: BuildPhaseType) -> Self
The name of the build phase. Valid values include:
- BUILD
-
Core build activities typically occur in this build phase.
- COMPLETED
-
The build has been completed.
- DOWNLOAD_SOURCE
-
Source code is being downloaded in this build phase.
- FINALIZING
-
The build process is completing in this build phase.
- INSTALL
-
Installation activities typically occur in this build phase.
- POST_BUILD
-
Post-build activities typically occur in this build phase.
- PRE_BUILD
-
Pre-build activities typically occur in this build phase.
- PROVISIONING
-
The build environment is being set up.
- QUEUED
-
The build has been submitted and is queued behind other submitted builds.
- SUBMITTED
-
The build has been submitted.
- UPLOAD_ARTIFACTS
-
Build output artifacts are being uploaded to the output location.
Sourcepub fn set_phase_type(self, input: Option<BuildPhaseType>) -> Self
pub fn set_phase_type(self, input: Option<BuildPhaseType>) -> Self
The name of the build phase. Valid values include:
- BUILD
-
Core build activities typically occur in this build phase.
- COMPLETED
-
The build has been completed.
- DOWNLOAD_SOURCE
-
Source code is being downloaded in this build phase.
- FINALIZING
-
The build process is completing in this build phase.
- INSTALL
-
Installation activities typically occur in this build phase.
- POST_BUILD
-
Post-build activities typically occur in this build phase.
- PRE_BUILD
-
Pre-build activities typically occur in this build phase.
- PROVISIONING
-
The build environment is being set up.
- QUEUED
-
The build has been submitted and is queued behind other submitted builds.
- SUBMITTED
-
The build has been submitted.
- UPLOAD_ARTIFACTS
-
Build output artifacts are being uploaded to the output location.
Sourcepub fn get_phase_type(&self) -> &Option<BuildPhaseType>
pub fn get_phase_type(&self) -> &Option<BuildPhaseType>
The name of the build phase. Valid values include:
- BUILD
-
Core build activities typically occur in this build phase.
- COMPLETED
-
The build has been completed.
- DOWNLOAD_SOURCE
-
Source code is being downloaded in this build phase.
- FINALIZING
-
The build process is completing in this build phase.
- INSTALL
-
Installation activities typically occur in this build phase.
- POST_BUILD
-
Post-build activities typically occur in this build phase.
- PRE_BUILD
-
Pre-build activities typically occur in this build phase.
- PROVISIONING
-
The build environment is being set up.
- QUEUED
-
The build has been submitted and is queued behind other submitted builds.
- SUBMITTED
-
The build has been submitted.
- UPLOAD_ARTIFACTS
-
Build output artifacts are being uploaded to the output location.
Sourcepub fn phase_status(self, input: StatusType) -> Self
pub fn phase_status(self, input: StatusType) -> Self
The current status of the build phase. Valid values include:
- FAILED
-
The build phase failed.
- FAULT
-
The build phase faulted.
- IN_PROGRESS
-
The build phase is still in progress.
- STOPPED
-
The build phase stopped.
- SUCCEEDED
-
The build phase succeeded.
- TIMED_OUT
-
The build phase timed out.
Sourcepub fn set_phase_status(self, input: Option<StatusType>) -> Self
pub fn set_phase_status(self, input: Option<StatusType>) -> Self
The current status of the build phase. Valid values include:
- FAILED
-
The build phase failed.
- FAULT
-
The build phase faulted.
- IN_PROGRESS
-
The build phase is still in progress.
- STOPPED
-
The build phase stopped.
- SUCCEEDED
-
The build phase succeeded.
- TIMED_OUT
-
The build phase timed out.
Sourcepub fn get_phase_status(&self) -> &Option<StatusType>
pub fn get_phase_status(&self) -> &Option<StatusType>
The current status of the build phase. Valid values include:
- FAILED
-
The build phase failed.
- FAULT
-
The build phase faulted.
- IN_PROGRESS
-
The build phase is still in progress.
- STOPPED
-
The build phase stopped.
- SUCCEEDED
-
The build phase succeeded.
- TIMED_OUT
-
The build phase timed out.
Sourcepub fn start_time(self, input: DateTime) -> Self
pub fn start_time(self, input: DateTime) -> Self
When the build phase started, expressed in Unix time format.
Sourcepub fn set_start_time(self, input: Option<DateTime>) -> Self
pub fn set_start_time(self, input: Option<DateTime>) -> Self
When the build phase started, expressed in Unix time format.
Sourcepub fn get_start_time(&self) -> &Option<DateTime>
pub fn get_start_time(&self) -> &Option<DateTime>
When the build phase started, expressed in Unix time format.
Sourcepub fn end_time(self, input: DateTime) -> Self
pub fn end_time(self, input: DateTime) -> Self
When the build phase ended, expressed in Unix time format.
Sourcepub fn set_end_time(self, input: Option<DateTime>) -> Self
pub fn set_end_time(self, input: Option<DateTime>) -> Self
When the build phase ended, expressed in Unix time format.
Sourcepub fn get_end_time(&self) -> &Option<DateTime>
pub fn get_end_time(&self) -> &Option<DateTime>
When the build phase ended, expressed in Unix time format.
Sourcepub fn duration_in_seconds(self, input: i64) -> Self
pub fn duration_in_seconds(self, input: i64) -> Self
How long, in seconds, between the starting and ending times of the build's phase.
Sourcepub fn set_duration_in_seconds(self, input: Option<i64>) -> Self
pub fn set_duration_in_seconds(self, input: Option<i64>) -> Self
How long, in seconds, between the starting and ending times of the build's phase.
Sourcepub fn get_duration_in_seconds(&self) -> &Option<i64>
pub fn get_duration_in_seconds(&self) -> &Option<i64>
How long, in seconds, between the starting and ending times of the build's phase.
Sourcepub fn contexts(self, input: PhaseContext) -> Self
pub fn contexts(self, input: PhaseContext) -> Self
Appends an item to contexts
.
To override the contents of this collection use set_contexts
.
Additional information about a build phase, especially to help troubleshoot a failed build.
Sourcepub fn set_contexts(self, input: Option<Vec<PhaseContext>>) -> Self
pub fn set_contexts(self, input: Option<Vec<PhaseContext>>) -> Self
Additional information about a build phase, especially to help troubleshoot a failed build.
Sourcepub fn get_contexts(&self) -> &Option<Vec<PhaseContext>>
pub fn get_contexts(&self) -> &Option<Vec<PhaseContext>>
Additional information about a build phase, especially to help troubleshoot a failed build.
Sourcepub fn build(self) -> BuildPhase
pub fn build(self) -> BuildPhase
Consumes the builder and constructs a BuildPhase
.
Trait Implementations§
Source§impl Clone for BuildPhaseBuilder
impl Clone for BuildPhaseBuilder
Source§fn clone(&self) -> BuildPhaseBuilder
fn clone(&self) -> BuildPhaseBuilder
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 BuildPhaseBuilder
impl Debug for BuildPhaseBuilder
Source§impl Default for BuildPhaseBuilder
impl Default for BuildPhaseBuilder
Source§fn default() -> BuildPhaseBuilder
fn default() -> BuildPhaseBuilder
Source§impl PartialEq for BuildPhaseBuilder
impl PartialEq for BuildPhaseBuilder
impl StructuralPartialEq for BuildPhaseBuilder
Auto Trait Implementations§
impl Freeze for BuildPhaseBuilder
impl RefUnwindSafe for BuildPhaseBuilder
impl Send for BuildPhaseBuilder
impl Sync for BuildPhaseBuilder
impl Unpin for BuildPhaseBuilder
impl UnwindSafe for BuildPhaseBuilder
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);