#[non_exhaustive]pub struct SessionActionSummaryBuilder { /* private fields */ }
Expand description
A builder for SessionActionSummary
.
Implementations§
Source§impl SessionActionSummaryBuilder
impl SessionActionSummaryBuilder
Sourcepub fn session_action_id(self, input: impl Into<String>) -> Self
pub fn session_action_id(self, input: impl Into<String>) -> Self
The session action ID.
This field is required.Sourcepub fn set_session_action_id(self, input: Option<String>) -> Self
pub fn set_session_action_id(self, input: Option<String>) -> Self
The session action ID.
Sourcepub fn get_session_action_id(&self) -> &Option<String>
pub fn get_session_action_id(&self) -> &Option<String>
The session action ID.
Sourcepub fn status(self, input: SessionActionStatus) -> Self
pub fn status(self, input: SessionActionStatus) -> Self
The status of the session action.
This field is required.Sourcepub fn set_status(self, input: Option<SessionActionStatus>) -> Self
pub fn set_status(self, input: Option<SessionActionStatus>) -> Self
The status of the session action.
Sourcepub fn get_status(&self) -> &Option<SessionActionStatus>
pub fn get_status(&self) -> &Option<SessionActionStatus>
The status of the session action.
Sourcepub fn started_at(self, input: DateTime) -> Self
pub fn started_at(self, input: DateTime) -> Self
The date and time the resource started running.
Sourcepub fn set_started_at(self, input: Option<DateTime>) -> Self
pub fn set_started_at(self, input: Option<DateTime>) -> Self
The date and time the resource started running.
Sourcepub fn get_started_at(&self) -> &Option<DateTime>
pub fn get_started_at(&self) -> &Option<DateTime>
The date and time the resource started running.
Sourcepub fn set_ended_at(self, input: Option<DateTime>) -> Self
pub fn set_ended_at(self, input: Option<DateTime>) -> Self
The date and time the resource ended running.
Sourcepub fn get_ended_at(&self) -> &Option<DateTime>
pub fn get_ended_at(&self) -> &Option<DateTime>
The date and time the resource ended running.
Sourcepub fn worker_updated_at(self, input: DateTime) -> Self
pub fn worker_updated_at(self, input: DateTime) -> Self
The Linux timestamp of the last date and time that the session action was updated.
Sourcepub fn set_worker_updated_at(self, input: Option<DateTime>) -> Self
pub fn set_worker_updated_at(self, input: Option<DateTime>) -> Self
The Linux timestamp of the last date and time that the session action was updated.
Sourcepub fn get_worker_updated_at(&self) -> &Option<DateTime>
pub fn get_worker_updated_at(&self) -> &Option<DateTime>
The Linux timestamp of the last date and time that the session action was updated.
Sourcepub fn progress_percent(self, input: f32) -> Self
pub fn progress_percent(self, input: f32) -> Self
The completion percentage for the session action.
Sourcepub fn set_progress_percent(self, input: Option<f32>) -> Self
pub fn set_progress_percent(self, input: Option<f32>) -> Self
The completion percentage for the session action.
Sourcepub fn get_progress_percent(&self) -> &Option<f32>
pub fn get_progress_percent(&self) -> &Option<f32>
The completion percentage for the session action.
Sourcepub fn definition(self, input: SessionActionDefinitionSummary) -> Self
pub fn definition(self, input: SessionActionDefinitionSummary) -> Self
The session action definition.
This field is required.Sourcepub fn set_definition(
self,
input: Option<SessionActionDefinitionSummary>,
) -> Self
pub fn set_definition( self, input: Option<SessionActionDefinitionSummary>, ) -> Self
The session action definition.
Sourcepub fn get_definition(&self) -> &Option<SessionActionDefinitionSummary>
pub fn get_definition(&self) -> &Option<SessionActionDefinitionSummary>
The session action definition.
Sourcepub fn build(self) -> Result<SessionActionSummary, BuildError>
pub fn build(self) -> Result<SessionActionSummary, BuildError>
Consumes the builder and constructs a SessionActionSummary
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for SessionActionSummaryBuilder
impl Clone for SessionActionSummaryBuilder
Source§fn clone(&self) -> SessionActionSummaryBuilder
fn clone(&self) -> SessionActionSummaryBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for SessionActionSummaryBuilder
impl Debug for SessionActionSummaryBuilder
Source§impl Default for SessionActionSummaryBuilder
impl Default for SessionActionSummaryBuilder
Source§fn default() -> SessionActionSummaryBuilder
fn default() -> SessionActionSummaryBuilder
impl StructuralPartialEq for SessionActionSummaryBuilder
Auto Trait Implementations§
impl Freeze for SessionActionSummaryBuilder
impl RefUnwindSafe for SessionActionSummaryBuilder
impl Send for SessionActionSummaryBuilder
impl Sync for SessionActionSummaryBuilder
impl Unpin for SessionActionSummaryBuilder
impl UnwindSafe for SessionActionSummaryBuilder
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);