#[non_exhaustive]pub struct GetStepOutput {Show 17 fields
pub step_id: String,
pub name: String,
pub lifecycle_status: StepLifecycleStatus,
pub lifecycle_status_message: Option<String>,
pub task_run_status: TaskRunStatus,
pub task_run_status_counts: HashMap<TaskRunStatus, i32>,
pub target_task_run_status: Option<StepTargetTaskRunStatus>,
pub created_at: DateTime,
pub created_by: String,
pub updated_at: Option<DateTime>,
pub updated_by: Option<String>,
pub started_at: Option<DateTime>,
pub ended_at: Option<DateTime>,
pub dependency_counts: Option<DependencyCounts>,
pub required_capabilities: Option<StepRequiredCapabilities>,
pub parameter_space: Option<ParameterSpace>,
pub description: Option<String>,
/* private fields */
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.step_id: String
The step ID.
name: String
The name of the step.
lifecycle_status: StepLifecycleStatus
The life cycle status of the step.
lifecycle_status_message: Option<String>
A message that describes the lifecycle status of the step.
task_run_status: TaskRunStatus
The task run status for the job.
task_run_status_counts: HashMap<TaskRunStatus, i32>
The number of tasks running on the job.
target_task_run_status: Option<StepTargetTaskRunStatus>
The task status with which the job started.
created_at: DateTime
The date and time the resource was created.
created_by: String
The user or system that created this resource.
updated_at: Option<DateTime>
The date and time the resource was updated.
updated_by: Option<String>
The user or system that updated this resource.
started_at: Option<DateTime>
The date and time the resource started running.
ended_at: Option<DateTime>
The date and time the resource ended running.
dependency_counts: Option<DependencyCounts>
The number of dependencies in the step.
required_capabilities: Option<StepRequiredCapabilities>
The required capabilities of the step.
parameter_space: Option<ParameterSpace>
A list of step parameters and the combination expression for the step.
description: Option<String>
The description of the step.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
Implementations§
Source§impl GetStepOutput
impl GetStepOutput
Sourcepub fn lifecycle_status(&self) -> &StepLifecycleStatus
pub fn lifecycle_status(&self) -> &StepLifecycleStatus
The life cycle status of the step.
Sourcepub fn lifecycle_status_message(&self) -> Option<&str>
pub fn lifecycle_status_message(&self) -> Option<&str>
A message that describes the lifecycle status of the step.
Sourcepub fn task_run_status(&self) -> &TaskRunStatus
pub fn task_run_status(&self) -> &TaskRunStatus
The task run status for the job.
Sourcepub fn task_run_status_counts(&self) -> &HashMap<TaskRunStatus, i32>
pub fn task_run_status_counts(&self) -> &HashMap<TaskRunStatus, i32>
The number of tasks running on the job.
Sourcepub fn target_task_run_status(&self) -> Option<&StepTargetTaskRunStatus>
pub fn target_task_run_status(&self) -> Option<&StepTargetTaskRunStatus>
The task status with which the job started.
Sourcepub fn created_at(&self) -> &DateTime
pub fn created_at(&self) -> &DateTime
The date and time the resource was created.
Sourcepub fn created_by(&self) -> &str
pub fn created_by(&self) -> &str
The user or system that created this resource.
Sourcepub fn updated_at(&self) -> Option<&DateTime>
pub fn updated_at(&self) -> Option<&DateTime>
The date and time the resource was updated.
Sourcepub fn updated_by(&self) -> Option<&str>
pub fn updated_by(&self) -> Option<&str>
The user or system that updated this resource.
Sourcepub fn started_at(&self) -> Option<&DateTime>
pub fn started_at(&self) -> Option<&DateTime>
The date and time the resource started running.
Sourcepub fn dependency_counts(&self) -> Option<&DependencyCounts>
pub fn dependency_counts(&self) -> Option<&DependencyCounts>
The number of dependencies in the step.
Sourcepub fn required_capabilities(&self) -> Option<&StepRequiredCapabilities>
pub fn required_capabilities(&self) -> Option<&StepRequiredCapabilities>
The required capabilities of the step.
Sourcepub fn parameter_space(&self) -> Option<&ParameterSpace>
pub fn parameter_space(&self) -> Option<&ParameterSpace>
A list of step parameters and the combination expression for the step.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The description of the step.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
Source§impl GetStepOutput
impl GetStepOutput
Sourcepub fn builder() -> GetStepOutputBuilder
pub fn builder() -> GetStepOutputBuilder
Creates a new builder-style object to manufacture GetStepOutput
.
Trait Implementations§
Source§impl Clone for GetStepOutput
impl Clone for GetStepOutput
Source§fn clone(&self) -> GetStepOutput
fn clone(&self) -> GetStepOutput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for GetStepOutput
impl Debug for GetStepOutput
Source§impl PartialEq for GetStepOutput
impl PartialEq for GetStepOutput
Source§impl RequestId for GetStepOutput
impl RequestId for GetStepOutput
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.impl StructuralPartialEq for GetStepOutput
Auto Trait Implementations§
impl Freeze for GetStepOutput
impl RefUnwindSafe for GetStepOutput
impl Send for GetStepOutput
impl Sync for GetStepOutput
impl Unpin for GetStepOutput
impl UnwindSafe for GetStepOutput
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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);