#[non_exhaustive]pub struct LensSummaryBuilder { /* private fields */ }
Expand description
A builder for LensSummary
.
Implementations§
Source§impl LensSummaryBuilder
impl LensSummaryBuilder
Sourcepub fn set_lens_arn(self, input: Option<String>) -> Self
pub fn set_lens_arn(self, input: Option<String>) -> Self
The ARN of the lens.
Sourcepub fn get_lens_arn(&self) -> &Option<String>
pub fn get_lens_arn(&self) -> &Option<String>
The ARN of the lens.
Sourcepub fn lens_alias(self, input: impl Into<String>) -> Self
pub fn lens_alias(self, input: impl Into<String>) -> Self
The alias of the lens.
For Amazon Web Services official lenses, this is either the lens alias, such as serverless
, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless
. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef
.
Each lens is identified by its LensSummary$LensAlias
.
Sourcepub fn set_lens_alias(self, input: Option<String>) -> Self
pub fn set_lens_alias(self, input: Option<String>) -> Self
The alias of the lens.
For Amazon Web Services official lenses, this is either the lens alias, such as serverless
, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless
. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef
.
Each lens is identified by its LensSummary$LensAlias
.
Sourcepub fn get_lens_alias(&self) -> &Option<String>
pub fn get_lens_alias(&self) -> &Option<String>
The alias of the lens.
For Amazon Web Services official lenses, this is either the lens alias, such as serverless
, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless
. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef
.
Each lens is identified by its LensSummary$LensAlias
.
Sourcepub fn set_lens_name(self, input: Option<String>) -> Self
pub fn set_lens_name(self, input: Option<String>) -> Self
The full name of the lens.
Sourcepub fn get_lens_name(&self) -> &Option<String>
pub fn get_lens_name(&self) -> &Option<String>
The full name of the lens.
Sourcepub fn set_lens_type(self, input: Option<LensType>) -> Self
pub fn set_lens_type(self, input: Option<LensType>) -> Self
The type of the lens.
Sourcepub fn get_lens_type(&self) -> &Option<LensType>
pub fn get_lens_type(&self) -> &Option<LensType>
The type of the lens.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description of the lens.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description of the lens.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description of the lens.
Sourcepub fn created_at(self, input: DateTime) -> Self
pub fn created_at(self, input: DateTime) -> Self
The date and time recorded.
Sourcepub fn set_created_at(self, input: Option<DateTime>) -> Self
pub fn set_created_at(self, input: Option<DateTime>) -> Self
The date and time recorded.
Sourcepub fn get_created_at(&self) -> &Option<DateTime>
pub fn get_created_at(&self) -> &Option<DateTime>
The date and time recorded.
Sourcepub fn updated_at(self, input: DateTime) -> Self
pub fn updated_at(self, input: DateTime) -> Self
The date and time recorded.
Sourcepub fn set_updated_at(self, input: Option<DateTime>) -> Self
pub fn set_updated_at(self, input: Option<DateTime>) -> Self
The date and time recorded.
Sourcepub fn get_updated_at(&self) -> &Option<DateTime>
pub fn get_updated_at(&self) -> &Option<DateTime>
The date and time recorded.
Sourcepub fn lens_version(self, input: impl Into<String>) -> Self
pub fn lens_version(self, input: impl Into<String>) -> Self
The version of the lens.
Sourcepub fn set_lens_version(self, input: Option<String>) -> Self
pub fn set_lens_version(self, input: Option<String>) -> Self
The version of the lens.
Sourcepub fn get_lens_version(&self) -> &Option<String>
pub fn get_lens_version(&self) -> &Option<String>
The version of the lens.
Sourcepub fn lens_status(self, input: LensStatus) -> Self
pub fn lens_status(self, input: LensStatus) -> Self
The status of the lens.
Sourcepub fn set_lens_status(self, input: Option<LensStatus>) -> Self
pub fn set_lens_status(self, input: Option<LensStatus>) -> Self
The status of the lens.
Sourcepub fn get_lens_status(&self) -> &Option<LensStatus>
pub fn get_lens_status(&self) -> &Option<LensStatus>
The status of the lens.
Sourcepub fn build(self) -> LensSummary
pub fn build(self) -> LensSummary
Consumes the builder and constructs a LensSummary
.
Trait Implementations§
Source§impl Clone for LensSummaryBuilder
impl Clone for LensSummaryBuilder
Source§fn clone(&self) -> LensSummaryBuilder
fn clone(&self) -> LensSummaryBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for LensSummaryBuilder
impl Debug for LensSummaryBuilder
Source§impl Default for LensSummaryBuilder
impl Default for LensSummaryBuilder
Source§fn default() -> LensSummaryBuilder
fn default() -> LensSummaryBuilder
Source§impl PartialEq for LensSummaryBuilder
impl PartialEq for LensSummaryBuilder
impl StructuralPartialEq for LensSummaryBuilder
Auto Trait Implementations§
impl Freeze for LensSummaryBuilder
impl RefUnwindSafe for LensSummaryBuilder
impl Send for LensSummaryBuilder
impl Sync for LensSummaryBuilder
impl Unpin for LensSummaryBuilder
impl UnwindSafe for LensSummaryBuilder
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);