#[non_exhaustive]pub struct ComponentSummary {Show 14 fields
pub arn: Option<String>,
pub name: Option<String>,
pub version: Option<String>,
pub platform: Option<Platform>,
pub supported_os_versions: Option<Vec<String>>,
pub state: Option<ComponentState>,
pub type: Option<ComponentType>,
pub owner: Option<String>,
pub description: Option<String>,
pub change_description: Option<String>,
pub date_created: Option<String>,
pub tags: Option<HashMap<String, String>>,
pub publisher: Option<String>,
pub obfuscate: bool,
}
Expand description
A high-level summary of a component.
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) of the component.
name: Option<String>
The name of the component.
version: Option<String>
The version of the component.
platform: Option<Platform>
The operating system platform of the component.
supported_os_versions: Option<Vec<String>>
The operating system (OS) version that the component supports. If the OS information is available, Image Builder performs a prefix match against the base image OS version during image recipe creation.
state: Option<ComponentState>
Describes the current status of the component.
type: Option<ComponentType>
The component type specifies whether Image Builder uses the component to build the image or only to test it.
owner: Option<String>
The owner of the component.
description: Option<String>
The description of the component.
change_description: Option<String>
The change description for the current version of the component.
date_created: Option<String>
The original creation date of the component.
The tags that apply to the component.
publisher: Option<String>
Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.
obfuscate: bool
Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.
Implementations§
Source§impl ComponentSummary
impl ComponentSummary
Sourcepub fn supported_os_versions(&self) -> &[String]
pub fn supported_os_versions(&self) -> &[String]
The operating system (OS) version that the component supports. If the OS information is available, Image Builder performs a prefix match against the base image OS version during image recipe creation.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .supported_os_versions.is_none()
.
Sourcepub fn state(&self) -> Option<&ComponentState>
pub fn state(&self) -> Option<&ComponentState>
Describes the current status of the component.
Sourcepub fn type(&self) -> Option<&ComponentType>
pub fn type(&self) -> Option<&ComponentType>
The component type specifies whether Image Builder uses the component to build the image or only to test it.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The description of the component.
Sourcepub fn change_description(&self) -> Option<&str>
pub fn change_description(&self) -> Option<&str>
The change description for the current version of the component.
Sourcepub fn date_created(&self) -> Option<&str>
pub fn date_created(&self) -> Option<&str>
The original creation date of the component.
The tags that apply to the component.
Source§impl ComponentSummary
impl ComponentSummary
Sourcepub fn builder() -> ComponentSummaryBuilder
pub fn builder() -> ComponentSummaryBuilder
Creates a new builder-style object to manufacture ComponentSummary
.
Trait Implementations§
Source§impl Clone for ComponentSummary
impl Clone for ComponentSummary
Source§fn clone(&self) -> ComponentSummary
fn clone(&self) -> ComponentSummary
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 ComponentSummary
impl Debug for ComponentSummary
Source§impl PartialEq for ComponentSummary
impl PartialEq for ComponentSummary
impl StructuralPartialEq for ComponentSummary
Auto Trait Implementations§
impl Freeze for ComponentSummary
impl RefUnwindSafe for ComponentSummary
impl Send for ComponentSummary
impl Sync for ComponentSummary
impl Unpin for ComponentSummary
impl UnwindSafe for ComponentSummary
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);