#[non_exhaustive]pub struct ComputeCapacityStatus {
pub desired: Option<i32>,
pub running: Option<i32>,
pub in_use: Option<i32>,
pub available: Option<i32>,
pub desired_user_sessions: Option<i32>,
pub available_user_sessions: Option<i32>,
pub active_user_sessions: Option<i32>,
pub actual_user_sessions: Option<i32>,
}
Expand description
Describes the capacity status for a fleet.
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.desired: Option<i32>
The desired number of streaming instances.
running: Option<i32>
The total number of simultaneous streaming instances that are running.
in_use: Option<i32>
The number of instances in use for streaming.
available: Option<i32>
The number of currently available instances that can be used to stream sessions.
desired_user_sessions: Option<i32>
The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your fleet can support in a steady state.
DesiredUserSessionCapacity = ActualUserSessionCapacity + PendingUserSessionCapacity
This only applies to multi-session fleets.
available_user_sessions: Option<i32>
The number of idle session slots currently available for user sessions.
AvailableUserSessionCapacity = ActualUserSessionCapacity - ActiveUserSessions
This only applies to multi-session fleets.
active_user_sessions: Option<i32>
The number of user sessions currently being used for streaming sessions. This only applies to multi-session fleets.
actual_user_sessions: Option<i32>
The total number of session slots that are available for streaming or are currently streaming.
ActualUserSessionCapacity = AvailableUserSessionCapacity + ActiveUserSessions
This only applies to multi-session fleets.
Implementations§
Source§impl ComputeCapacityStatus
impl ComputeCapacityStatus
Sourcepub fn running(&self) -> Option<i32>
pub fn running(&self) -> Option<i32>
The total number of simultaneous streaming instances that are running.
Sourcepub fn available(&self) -> Option<i32>
pub fn available(&self) -> Option<i32>
The number of currently available instances that can be used to stream sessions.
Sourcepub fn desired_user_sessions(&self) -> Option<i32>
pub fn desired_user_sessions(&self) -> Option<i32>
The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your fleet can support in a steady state.
DesiredUserSessionCapacity = ActualUserSessionCapacity + PendingUserSessionCapacity
This only applies to multi-session fleets.
Sourcepub fn available_user_sessions(&self) -> Option<i32>
pub fn available_user_sessions(&self) -> Option<i32>
The number of idle session slots currently available for user sessions.
AvailableUserSessionCapacity = ActualUserSessionCapacity - ActiveUserSessions
This only applies to multi-session fleets.
Sourcepub fn active_user_sessions(&self) -> Option<i32>
pub fn active_user_sessions(&self) -> Option<i32>
The number of user sessions currently being used for streaming sessions. This only applies to multi-session fleets.
Sourcepub fn actual_user_sessions(&self) -> Option<i32>
pub fn actual_user_sessions(&self) -> Option<i32>
The total number of session slots that are available for streaming or are currently streaming.
ActualUserSessionCapacity = AvailableUserSessionCapacity + ActiveUserSessions
This only applies to multi-session fleets.
Source§impl ComputeCapacityStatus
impl ComputeCapacityStatus
Sourcepub fn builder() -> ComputeCapacityStatusBuilder
pub fn builder() -> ComputeCapacityStatusBuilder
Creates a new builder-style object to manufacture ComputeCapacityStatus
.
Trait Implementations§
Source§impl Clone for ComputeCapacityStatus
impl Clone for ComputeCapacityStatus
Source§fn clone(&self) -> ComputeCapacityStatus
fn clone(&self) -> ComputeCapacityStatus
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ComputeCapacityStatus
impl Debug for ComputeCapacityStatus
Source§impl PartialEq for ComputeCapacityStatus
impl PartialEq for ComputeCapacityStatus
impl StructuralPartialEq for ComputeCapacityStatus
Auto Trait Implementations§
impl Freeze for ComputeCapacityStatus
impl RefUnwindSafe for ComputeCapacityStatus
impl Send for ComputeCapacityStatus
impl Sync for ComputeCapacityStatus
impl Unpin for ComputeCapacityStatus
impl UnwindSafe for ComputeCapacityStatus
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);