#[non_exhaustive]pub struct WrappedKeyBuilder { /* private fields */ }
Expand description
A builder for WrappedKey
.
Implementations§
Source§impl WrappedKeyBuilder
impl WrappedKeyBuilder
Sourcepub fn wrapping_key_arn(self, input: impl Into<String>) -> Self
pub fn wrapping_key_arn(self, input: impl Into<String>) -> Self
The KeyARN
of the wrapped key.
Sourcepub fn set_wrapping_key_arn(self, input: Option<String>) -> Self
pub fn set_wrapping_key_arn(self, input: Option<String>) -> Self
The KeyARN
of the wrapped key.
Sourcepub fn get_wrapping_key_arn(&self) -> &Option<String>
pub fn get_wrapping_key_arn(&self) -> &Option<String>
The KeyARN
of the wrapped key.
Sourcepub fn wrapped_key_material_format(
self,
input: WrappedKeyMaterialFormat,
) -> Self
pub fn wrapped_key_material_format( self, input: WrappedKeyMaterialFormat, ) -> Self
The key block format of a wrapped key.
This field is required.Sourcepub fn set_wrapped_key_material_format(
self,
input: Option<WrappedKeyMaterialFormat>,
) -> Self
pub fn set_wrapped_key_material_format( self, input: Option<WrappedKeyMaterialFormat>, ) -> Self
The key block format of a wrapped key.
Sourcepub fn get_wrapped_key_material_format(
&self,
) -> &Option<WrappedKeyMaterialFormat>
pub fn get_wrapped_key_material_format( &self, ) -> &Option<WrappedKeyMaterialFormat>
The key block format of a wrapped key.
Sourcepub fn key_material(self, input: impl Into<String>) -> Self
pub fn key_material(self, input: impl Into<String>) -> Self
Parameter information for generating a wrapped key using TR-31 or TR-34 skey exchange method.
This field is required.Sourcepub fn set_key_material(self, input: Option<String>) -> Self
pub fn set_key_material(self, input: Option<String>) -> Self
Parameter information for generating a wrapped key using TR-31 or TR-34 skey exchange method.
Sourcepub fn get_key_material(&self) -> &Option<String>
pub fn get_key_material(&self) -> &Option<String>
Parameter information for generating a wrapped key using TR-31 or TR-34 skey exchange method.
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.
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 key_check_value_algorithm(self, input: KeyCheckValueAlgorithm) -> Self
pub fn key_check_value_algorithm(self, input: KeyCheckValueAlgorithm) -> Self
The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.
For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.
Sourcepub fn set_key_check_value_algorithm(
self,
input: Option<KeyCheckValueAlgorithm>,
) -> Self
pub fn set_key_check_value_algorithm( self, input: Option<KeyCheckValueAlgorithm>, ) -> Self
The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.
For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.
Sourcepub fn get_key_check_value_algorithm(&self) -> &Option<KeyCheckValueAlgorithm>
pub fn get_key_check_value_algorithm(&self) -> &Option<KeyCheckValueAlgorithm>
The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.
For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.
Sourcepub fn build(self) -> Result<WrappedKey, BuildError>
pub fn build(self) -> Result<WrappedKey, BuildError>
Consumes the builder and constructs a WrappedKey
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for WrappedKeyBuilder
impl Clone for WrappedKeyBuilder
Source§fn clone(&self) -> WrappedKeyBuilder
fn clone(&self) -> WrappedKeyBuilder
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 WrappedKeyBuilder
impl Debug for WrappedKeyBuilder
Source§impl Default for WrappedKeyBuilder
impl Default for WrappedKeyBuilder
Source§fn default() -> WrappedKeyBuilder
fn default() -> WrappedKeyBuilder
Source§impl PartialEq for WrappedKeyBuilder
impl PartialEq for WrappedKeyBuilder
impl StructuralPartialEq for WrappedKeyBuilder
Auto Trait Implementations§
impl Freeze for WrappedKeyBuilder
impl RefUnwindSafe for WrappedKeyBuilder
impl Send for WrappedKeyBuilder
impl Sync for WrappedKeyBuilder
impl Unpin for WrappedKeyBuilder
impl UnwindSafe for WrappedKeyBuilder
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);