#[non_exhaustive]pub struct InstanceSummary {
pub deployment_id: Option<String>,
pub instance_id: Option<String>,
pub status: Option<InstanceStatus>,
pub last_updated_at: Option<DateTime>,
pub lifecycle_events: Option<Vec<LifecycleEvent>>,
pub instance_type: Option<InstanceType>,
}
Expand description
Information about an instance in a deployment.
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.deployment_id: Option<String>
The unique ID of a deployment.
instance_id: Option<String>
The instance ID.
status: Option<InstanceStatus>
The deployment status for this instance:
-
Pending
: The deployment is pending for this instance. -
In Progress
: The deployment is in progress for this instance. -
Succeeded
: The deployment has succeeded for this instance. -
Failed
: The deployment has failed for this instance. -
Skipped
: The deployment has been skipped for this instance. -
Unknown
: The deployment status is unknown for this instance.
last_updated_at: Option<DateTime>
A timestamp that indicates when the instance information was last updated.
lifecycle_events: Option<Vec<LifecycleEvent>>
A list of lifecycle events for this instance.
instance_type: Option<InstanceType>
Information about which environment an instance belongs to in a blue/green deployment.
-
BLUE: The instance is part of the original environment.
-
GREEN: The instance is part of the replacement environment.
Implementationsยง
Sourceยงimpl InstanceSummary
impl InstanceSummary
Sourcepub fn deployment_id(&self) -> Option<&str>
pub fn deployment_id(&self) -> Option<&str>
The unique ID of a deployment.
Sourcepub fn instance_id(&self) -> Option<&str>
pub fn instance_id(&self) -> Option<&str>
The instance ID.
Sourcepub fn status(&self) -> Option<&InstanceStatus>
pub fn status(&self) -> Option<&InstanceStatus>
The deployment status for this instance:
-
Pending
: The deployment is pending for this instance. -
In Progress
: The deployment is in progress for this instance. -
Succeeded
: The deployment has succeeded for this instance. -
Failed
: The deployment has failed for this instance. -
Skipped
: The deployment has been skipped for this instance. -
Unknown
: The deployment status is unknown for this instance.
Sourcepub fn last_updated_at(&self) -> Option<&DateTime>
pub fn last_updated_at(&self) -> Option<&DateTime>
A timestamp that indicates when the instance information was last updated.
Sourcepub fn lifecycle_events(&self) -> &[LifecycleEvent]
pub fn lifecycle_events(&self) -> &[LifecycleEvent]
A list of lifecycle events for this instance.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .lifecycle_events.is_none()
.
Sourcepub fn instance_type(&self) -> Option<&InstanceType>
pub fn instance_type(&self) -> Option<&InstanceType>
Information about which environment an instance belongs to in a blue/green deployment.
-
BLUE: The instance is part of the original environment.
-
GREEN: The instance is part of the replacement environment.
Sourceยงimpl InstanceSummary
impl InstanceSummary
Sourcepub fn builder() -> InstanceSummaryBuilder
pub fn builder() -> InstanceSummaryBuilder
Creates a new builder-style object to manufacture InstanceSummary
.
Trait Implementationsยง
Sourceยงimpl Clone for InstanceSummary
impl Clone for InstanceSummary
Sourceยงfn clone(&self) -> InstanceSummary
fn clone(&self) -> InstanceSummary
1.0.0 ยท Sourceยงfn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSourceยงimpl Debug for InstanceSummary
impl Debug for InstanceSummary
Sourceยงimpl PartialEq for InstanceSummary
impl PartialEq for InstanceSummary
impl StructuralPartialEq for InstanceSummary
Auto Trait Implementationsยง
impl Freeze for InstanceSummary
impl RefUnwindSafe for InstanceSummary
impl Send for InstanceSummary
impl Sync for InstanceSummary
impl Unpin for InstanceSummary
impl UnwindSafe for InstanceSummary
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);