#[non_exhaustive]pub struct SandboxSessionPhase {
pub phase_type: Option<String>,
pub phase_status: Option<StatusType>,
pub start_time: Option<DateTime>,
pub end_time: Option<DateTime>,
pub duration_in_seconds: Option<i64>,
pub contexts: Option<Vec<PhaseContext>>,
}
Expand description
Contains information about the sandbox phase.
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.phase_type: Option<String>
The name of the sandbox phase.
phase_status: Option<StatusType>
The current status of the sandbox phase. Valid values include:
- FAILED
-
The sandbox phase failed.
- FAULT
-
The sandbox phase faulted.
- IN_PROGRESS
-
The sandbox phase is still in progress.
- STOPPED
-
The sandbox phase stopped.
- SUCCEEDED
-
The sandbox phase succeeded.
- TIMED_OUT
-
The sandbox phase timed out.
start_time: Option<DateTime>
When the sandbox phase started, expressed in Unix time format.
end_time: Option<DateTime>
When the sandbox phase ended, expressed in Unix time format.
duration_in_seconds: Option<i64>
How long, in seconds, between the starting and ending times of the sandbox's phase.
contexts: Option<Vec<PhaseContext>>
An array of PhaseContext
objects.
Implementations§
Source§impl SandboxSessionPhase
impl SandboxSessionPhase
Sourcepub fn phase_type(&self) -> Option<&str>
pub fn phase_type(&self) -> Option<&str>
The name of the sandbox phase.
Sourcepub fn phase_status(&self) -> Option<&StatusType>
pub fn phase_status(&self) -> Option<&StatusType>
The current status of the sandbox phase. Valid values include:
- FAILED
-
The sandbox phase failed.
- FAULT
-
The sandbox phase faulted.
- IN_PROGRESS
-
The sandbox phase is still in progress.
- STOPPED
-
The sandbox phase stopped.
- SUCCEEDED
-
The sandbox phase succeeded.
- TIMED_OUT
-
The sandbox phase timed out.
Sourcepub fn start_time(&self) -> Option<&DateTime>
pub fn start_time(&self) -> Option<&DateTime>
When the sandbox phase started, expressed in Unix time format.
Sourcepub fn end_time(&self) -> Option<&DateTime>
pub fn end_time(&self) -> Option<&DateTime>
When the sandbox phase ended, expressed in Unix time format.
Sourcepub fn duration_in_seconds(&self) -> Option<i64>
pub fn duration_in_seconds(&self) -> Option<i64>
How long, in seconds, between the starting and ending times of the sandbox's phase.
Sourcepub fn contexts(&self) -> &[PhaseContext]
pub fn contexts(&self) -> &[PhaseContext]
An array of PhaseContext
objects.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .contexts.is_none()
.
Source§impl SandboxSessionPhase
impl SandboxSessionPhase
Sourcepub fn builder() -> SandboxSessionPhaseBuilder
pub fn builder() -> SandboxSessionPhaseBuilder
Creates a new builder-style object to manufacture SandboxSessionPhase
.
Trait Implementations§
Source§impl Clone for SandboxSessionPhase
impl Clone for SandboxSessionPhase
Source§fn clone(&self) -> SandboxSessionPhase
fn clone(&self) -> SandboxSessionPhase
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 SandboxSessionPhase
impl Debug for SandboxSessionPhase
Source§impl PartialEq for SandboxSessionPhase
impl PartialEq for SandboxSessionPhase
impl StructuralPartialEq for SandboxSessionPhase
Auto Trait Implementations§
impl Freeze for SandboxSessionPhase
impl RefUnwindSafe for SandboxSessionPhase
impl Send for SandboxSessionPhase
impl Sync for SandboxSessionPhase
impl Unpin for SandboxSessionPhase
impl UnwindSafe for SandboxSessionPhase
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);