#[non_exhaustive]pub struct StreamingImage {Show 13 fields
pub arn: Option<String>,
pub description: Option<String>,
pub ec2_image_id: Option<String>,
pub encryption_configuration: Option<StreamingImageEncryptionConfiguration>,
pub eula_ids: Option<Vec<String>>,
pub name: Option<String>,
pub owner: Option<String>,
pub platform: Option<String>,
pub state: Option<StreamingImageState>,
pub status_code: Option<StreamingImageStatusCode>,
pub status_message: Option<String>,
pub streaming_image_id: Option<String>,
pub tags: Option<HashMap<String, String>>,
}
Expand description
Represents a streaming image resource.
Streaming images are used by studio users to select which operating system and software they want to use in a Nimble Studio streaming session.
Amazon provides a number of streaming images that include popular 3rd-party software.
You can create your own streaming images using an Amazon EC2 machine image that you create for this purpose. You can also include software that your users require.
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.arn: Option<String>
The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
description: Option<String>
A human-readable description of the streaming image.
ec2_image_id: Option<String>
The ID of an EC2 machine image with which to create the streaming image.
encryption_configuration: Option<StreamingImageEncryptionConfiguration>
The encryption configuration.
eula_ids: Option<Vec<String>>
The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.
name: Option<String>
A friendly name for a streaming image resource.
owner: Option<String>
The owner of the streaming image, either the studioId
that contains the streaming image, or amazon
for images that are provided by Amazon Nimble Studio.
platform: Option<String>
The platform of the streaming image, either Windows or Linux.
state: Option<StreamingImageState>
The current state.
status_code: Option<StreamingImageStatusCode>
The status code.
status_message: Option<String>
The status message for the streaming image.
streaming_image_id: Option<String>
The ID of the streaming image.
A collection of labels, in the form of key-value pairs, that apply to this resource.
Implementations§
Source§impl StreamingImage
impl StreamingImage
Sourcepub fn arn(&self) -> Option<&str>
pub fn arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A human-readable description of the streaming image.
Sourcepub fn ec2_image_id(&self) -> Option<&str>
pub fn ec2_image_id(&self) -> Option<&str>
The ID of an EC2 machine image with which to create the streaming image.
Sourcepub fn encryption_configuration(
&self,
) -> Option<&StreamingImageEncryptionConfiguration>
pub fn encryption_configuration( &self, ) -> Option<&StreamingImageEncryptionConfiguration>
The encryption configuration.
Sourcepub fn eula_ids(&self) -> &[String]
pub fn eula_ids(&self) -> &[String]
The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .eula_ids.is_none()
.
Sourcepub fn owner(&self) -> Option<&str>
pub fn owner(&self) -> Option<&str>
The owner of the streaming image, either the studioId
that contains the streaming image, or amazon
for images that are provided by Amazon Nimble Studio.
Sourcepub fn platform(&self) -> Option<&str>
pub fn platform(&self) -> Option<&str>
The platform of the streaming image, either Windows or Linux.
Sourcepub fn state(&self) -> Option<&StreamingImageState>
pub fn state(&self) -> Option<&StreamingImageState>
The current state.
Sourcepub fn status_code(&self) -> Option<&StreamingImageStatusCode>
pub fn status_code(&self) -> Option<&StreamingImageStatusCode>
The status code.
Sourcepub fn status_message(&self) -> Option<&str>
pub fn status_message(&self) -> Option<&str>
The status message for the streaming image.
Sourcepub fn streaming_image_id(&self) -> Option<&str>
pub fn streaming_image_id(&self) -> Option<&str>
The ID of the streaming image.
A collection of labels, in the form of key-value pairs, that apply to this resource.
Source§impl StreamingImage
impl StreamingImage
Sourcepub fn builder() -> StreamingImageBuilder
pub fn builder() -> StreamingImageBuilder
Creates a new builder-style object to manufacture StreamingImage
.
Trait Implementations§
Source§impl Clone for StreamingImage
impl Clone for StreamingImage
Source§fn clone(&self) -> StreamingImage
fn clone(&self) -> StreamingImage
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for StreamingImage
impl Debug for StreamingImage
Source§impl PartialEq for StreamingImage
impl PartialEq for StreamingImage
impl StructuralPartialEq for StreamingImage
Auto Trait Implementations§
impl Freeze for StreamingImage
impl RefUnwindSafe for StreamingImage
impl Send for StreamingImage
impl Sync for StreamingImage
impl Unpin for StreamingImage
impl UnwindSafe for StreamingImage
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);