#[non_exhaustive]pub struct SessionStatusBuilder { /* private fields */ }
Expand description
A builder for SessionStatus
.
Implementations§
Source§impl SessionStatusBuilder
impl SessionStatusBuilder
Sourcepub fn start_date_time(self, input: DateTime) -> Self
pub fn start_date_time(self, input: DateTime) -> Self
The date and time that the session started.
Sourcepub fn set_start_date_time(self, input: Option<DateTime>) -> Self
pub fn set_start_date_time(self, input: Option<DateTime>) -> Self
The date and time that the session started.
Sourcepub fn get_start_date_time(&self) -> &Option<DateTime>
pub fn get_start_date_time(&self) -> &Option<DateTime>
The date and time that the session started.
Sourcepub fn last_modified_date_time(self, input: DateTime) -> Self
pub fn last_modified_date_time(self, input: DateTime) -> Self
The most recent date and time that the session was modified.
Sourcepub fn set_last_modified_date_time(self, input: Option<DateTime>) -> Self
pub fn set_last_modified_date_time(self, input: Option<DateTime>) -> Self
The most recent date and time that the session was modified.
Sourcepub fn get_last_modified_date_time(&self) -> &Option<DateTime>
pub fn get_last_modified_date_time(&self) -> &Option<DateTime>
The most recent date and time that the session was modified.
Sourcepub fn end_date_time(self, input: DateTime) -> Self
pub fn end_date_time(self, input: DateTime) -> Self
The date and time that the session ended.
Sourcepub fn set_end_date_time(self, input: Option<DateTime>) -> Self
pub fn set_end_date_time(self, input: Option<DateTime>) -> Self
The date and time that the session ended.
Sourcepub fn get_end_date_time(&self) -> &Option<DateTime>
pub fn get_end_date_time(&self) -> &Option<DateTime>
The date and time that the session ended.
Sourcepub fn idle_since_date_time(self, input: DateTime) -> Self
pub fn idle_since_date_time(self, input: DateTime) -> Self
The date and time starting at which the session became idle. Can be empty if the session is not currently idle.
Sourcepub fn set_idle_since_date_time(self, input: Option<DateTime>) -> Self
pub fn set_idle_since_date_time(self, input: Option<DateTime>) -> Self
The date and time starting at which the session became idle. Can be empty if the session is not currently idle.
Sourcepub fn get_idle_since_date_time(&self) -> &Option<DateTime>
pub fn get_idle_since_date_time(&self) -> &Option<DateTime>
The date and time starting at which the session became idle. Can be empty if the session is not currently idle.
Sourcepub fn state(self, input: SessionState) -> Self
pub fn state(self, input: SessionState) -> Self
The state of the session. A description of each state follows.
CREATING
- The session is being started, including acquiring resources.
CREATED
- The session has been started.
IDLE
- The session is able to accept a calculation.
BUSY
- The session is processing another task and is unable to accept a calculation.
TERMINATING
- The session is in the process of shutting down.
TERMINATED
- The session and its resources are no longer running.
DEGRADED
- The session has no healthy coordinators.
FAILED
- Due to a failure, the session and its resources are no longer running.
Sourcepub fn set_state(self, input: Option<SessionState>) -> Self
pub fn set_state(self, input: Option<SessionState>) -> Self
The state of the session. A description of each state follows.
CREATING
- The session is being started, including acquiring resources.
CREATED
- The session has been started.
IDLE
- The session is able to accept a calculation.
BUSY
- The session is processing another task and is unable to accept a calculation.
TERMINATING
- The session is in the process of shutting down.
TERMINATED
- The session and its resources are no longer running.
DEGRADED
- The session has no healthy coordinators.
FAILED
- Due to a failure, the session and its resources are no longer running.
Sourcepub fn get_state(&self) -> &Option<SessionState>
pub fn get_state(&self) -> &Option<SessionState>
The state of the session. A description of each state follows.
CREATING
- The session is being started, including acquiring resources.
CREATED
- The session has been started.
IDLE
- The session is able to accept a calculation.
BUSY
- The session is processing another task and is unable to accept a calculation.
TERMINATING
- The session is in the process of shutting down.
TERMINATED
- The session and its resources are no longer running.
DEGRADED
- The session has no healthy coordinators.
FAILED
- Due to a failure, the session and its resources are no longer running.
Sourcepub fn state_change_reason(self, input: impl Into<String>) -> Self
pub fn state_change_reason(self, input: impl Into<String>) -> Self
The reason for the session state change (for example, canceled because the session was terminated).
Sourcepub fn set_state_change_reason(self, input: Option<String>) -> Self
pub fn set_state_change_reason(self, input: Option<String>) -> Self
The reason for the session state change (for example, canceled because the session was terminated).
Sourcepub fn get_state_change_reason(&self) -> &Option<String>
pub fn get_state_change_reason(&self) -> &Option<String>
The reason for the session state change (for example, canceled because the session was terminated).
Sourcepub fn build(self) -> SessionStatus
pub fn build(self) -> SessionStatus
Consumes the builder and constructs a SessionStatus
.
Trait Implementations§
Source§impl Clone for SessionStatusBuilder
impl Clone for SessionStatusBuilder
Source§fn clone(&self) -> SessionStatusBuilder
fn clone(&self) -> SessionStatusBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for SessionStatusBuilder
impl Debug for SessionStatusBuilder
Source§impl Default for SessionStatusBuilder
impl Default for SessionStatusBuilder
Source§fn default() -> SessionStatusBuilder
fn default() -> SessionStatusBuilder
Source§impl PartialEq for SessionStatusBuilder
impl PartialEq for SessionStatusBuilder
impl StructuralPartialEq for SessionStatusBuilder
Auto Trait Implementations§
impl Freeze for SessionStatusBuilder
impl RefUnwindSafe for SessionStatusBuilder
impl Send for SessionStatusBuilder
impl Sync for SessionStatusBuilder
impl Unpin for SessionStatusBuilder
impl UnwindSafe for SessionStatusBuilder
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);