#[non_exhaustive]pub struct KeySummaryBuilder { /* private fields */ }
Expand description
A builder for KeySummary
.
Implementations§
Source§impl KeySummaryBuilder
impl KeySummaryBuilder
Sourcepub fn key_arn(self, input: impl Into<String>) -> Self
pub fn key_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the key.
This field is required.Sourcepub fn set_key_arn(self, input: Option<String>) -> Self
pub fn set_key_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the key.
Sourcepub fn get_key_arn(&self) -> &Option<String>
pub fn get_key_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the key.
Sourcepub fn key_state(self, input: KeyState) -> Self
pub fn key_state(self, input: KeyState) -> Self
The state of an Amazon Web Services Payment Cryptography that is being created or deleted.
This field is required.Sourcepub fn set_key_state(self, input: Option<KeyState>) -> Self
pub fn set_key_state(self, input: Option<KeyState>) -> Self
The state of an Amazon Web Services Payment Cryptography that is being created or deleted.
Sourcepub fn get_key_state(&self) -> &Option<KeyState>
pub fn get_key_state(&self) -> &Option<KeyState>
The state of an Amazon Web Services Payment Cryptography that is being created or deleted.
Sourcepub fn key_attributes(self, input: KeyAttributes) -> Self
pub fn key_attributes(self, input: KeyAttributes) -> Self
The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.
This field is required.Sourcepub fn set_key_attributes(self, input: Option<KeyAttributes>) -> Self
pub fn set_key_attributes(self, input: Option<KeyAttributes>) -> Self
The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.
Sourcepub fn get_key_attributes(&self) -> &Option<KeyAttributes>
pub fn get_key_attributes(&self) -> &Option<KeyAttributes>
The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.
Sourcepub fn key_check_value(self, input: impl Into<String>) -> Self
pub fn key_check_value(self, input: impl Into<String>) -> Self
The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.
This field is required.Sourcepub fn set_key_check_value(self, input: Option<String>) -> Self
pub fn set_key_check_value(self, input: Option<String>) -> Self
The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.
Sourcepub fn get_key_check_value(&self) -> &Option<String>
pub fn get_key_check_value(&self) -> &Option<String>
The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.
Sourcepub fn exportable(self, input: bool) -> Self
pub fn exportable(self, input: bool) -> Self
Specifies whether the key is exportable. This data is immutable after the key is created.
This field is required.Sourcepub fn set_exportable(self, input: Option<bool>) -> Self
pub fn set_exportable(self, input: Option<bool>) -> Self
Specifies whether the key is exportable. This data is immutable after the key is created.
Sourcepub fn get_exportable(&self) -> &Option<bool>
pub fn get_exportable(&self) -> &Option<bool>
Specifies whether the key is exportable. This data is immutable after the key is created.
Sourcepub fn enabled(self, input: bool) -> Self
pub fn enabled(self, input: bool) -> Self
Specifies whether the key is enabled.
This field is required.Sourcepub fn set_enabled(self, input: Option<bool>) -> Self
pub fn set_enabled(self, input: Option<bool>) -> Self
Specifies whether the key is enabled.
Sourcepub fn get_enabled(&self) -> &Option<bool>
pub fn get_enabled(&self) -> &Option<bool>
Specifies whether the key is enabled.
Sourcepub fn build(self) -> Result<KeySummary, BuildError>
pub fn build(self) -> Result<KeySummary, BuildError>
Consumes the builder and constructs a KeySummary
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for KeySummaryBuilder
impl Clone for KeySummaryBuilder
Source§fn clone(&self) -> KeySummaryBuilder
fn clone(&self) -> KeySummaryBuilder
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 KeySummaryBuilder
impl Debug for KeySummaryBuilder
Source§impl Default for KeySummaryBuilder
impl Default for KeySummaryBuilder
Source§fn default() -> KeySummaryBuilder
fn default() -> KeySummaryBuilder
Source§impl PartialEq for KeySummaryBuilder
impl PartialEq for KeySummaryBuilder
impl StructuralPartialEq for KeySummaryBuilder
Auto Trait Implementations§
impl Freeze for KeySummaryBuilder
impl RefUnwindSafe for KeySummaryBuilder
impl Send for KeySummaryBuilder
impl Sync for KeySummaryBuilder
impl Unpin for KeySummaryBuilder
impl UnwindSafe for KeySummaryBuilder
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);