#[non_exhaustive]pub enum AuthenticationMetadata {
ApiKeyConnectionMetadata(ApiKeyConnectionMetadata),
AuthorizationCodeGrantMetadata(AuthorizationCodeGrantMetadata),
BasicAuthConnectionMetadata(BasicAuthConnectionMetadata),
ClientCredentialsGrantMetadata(ClientCredentialsGrantMetadata),
IamConnectionMetadata(IamConnectionMetadata),
NoneConnectionMetadata(NoneConnectionMetadata),
#[non_exhaustive] Unknown,
}Expand description
Union type containing authentication metadata for different authentication methods.
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
ApiKeyConnectionMetadata(ApiKeyConnectionMetadata)
API key authentication metadata.
AuthorizationCodeGrantMetadata(AuthorizationCodeGrantMetadata)
OAuth 2.0 authorization code grant authentication metadata.
BasicAuthConnectionMetadata(BasicAuthConnectionMetadata)
Basic authentication metadata using username and password.
ClientCredentialsGrantMetadata(ClientCredentialsGrantMetadata)
OAuth 2.0 client credentials grant authentication metadata.
IamConnectionMetadata(IamConnectionMetadata)
IAM role-based authentication metadata for Amazon Web Services services.
NoneConnectionMetadata(NoneConnectionMetadata)
No authentication metadata for services that don't require authentication.
#[non_exhaustive]Unknown
The Unknown variant represents cases where new union variant was received. Consider upgrading the SDK to the latest available version.
An unknown enum variant
Note: If you encounter this error, consider upgrading your SDK to the latest version.
The Unknown variant represents cases where the server sent a value that wasn’t recognized
by the client. This can happen when the server adds new functionality, but the client has not been updated.
To investigate this, consider turning on debug logging to print the raw HTTP response.
Implementations§
Source§impl AuthenticationMetadata
impl AuthenticationMetadata
Sourcepub fn as_api_key_connection_metadata(
&self,
) -> Result<&ApiKeyConnectionMetadata, &Self>
pub fn as_api_key_connection_metadata( &self, ) -> Result<&ApiKeyConnectionMetadata, &Self>
Tries to convert the enum instance into ApiKeyConnectionMetadata, extracting the inner ApiKeyConnectionMetadata.
Returns Err(&Self) if it can’t be converted.
Sourcepub fn is_api_key_connection_metadata(&self) -> bool
pub fn is_api_key_connection_metadata(&self) -> bool
Returns true if this is a ApiKeyConnectionMetadata.
Tries to convert the enum instance into AuthorizationCodeGrantMetadata, extracting the inner AuthorizationCodeGrantMetadata.
Returns Err(&Self) if it can’t be converted.
Returns true if this is a AuthorizationCodeGrantMetadata.
Sourcepub fn as_basic_auth_connection_metadata(
&self,
) -> Result<&BasicAuthConnectionMetadata, &Self>
pub fn as_basic_auth_connection_metadata( &self, ) -> Result<&BasicAuthConnectionMetadata, &Self>
Tries to convert the enum instance into BasicAuthConnectionMetadata, extracting the inner BasicAuthConnectionMetadata.
Returns Err(&Self) if it can’t be converted.
Sourcepub fn is_basic_auth_connection_metadata(&self) -> bool
pub fn is_basic_auth_connection_metadata(&self) -> bool
Returns true if this is a BasicAuthConnectionMetadata.
Sourcepub fn as_client_credentials_grant_metadata(
&self,
) -> Result<&ClientCredentialsGrantMetadata, &Self>
pub fn as_client_credentials_grant_metadata( &self, ) -> Result<&ClientCredentialsGrantMetadata, &Self>
Tries to convert the enum instance into ClientCredentialsGrantMetadata, extracting the inner ClientCredentialsGrantMetadata.
Returns Err(&Self) if it can’t be converted.
Sourcepub fn is_client_credentials_grant_metadata(&self) -> bool
pub fn is_client_credentials_grant_metadata(&self) -> bool
Returns true if this is a ClientCredentialsGrantMetadata.
Sourcepub fn as_iam_connection_metadata(
&self,
) -> Result<&IamConnectionMetadata, &Self>
pub fn as_iam_connection_metadata( &self, ) -> Result<&IamConnectionMetadata, &Self>
Tries to convert the enum instance into IamConnectionMetadata, extracting the inner IamConnectionMetadata.
Returns Err(&Self) if it can’t be converted.
Sourcepub fn is_iam_connection_metadata(&self) -> bool
pub fn is_iam_connection_metadata(&self) -> bool
Returns true if this is a IamConnectionMetadata.
Sourcepub fn as_none_connection_metadata(
&self,
) -> Result<&NoneConnectionMetadata, &Self>
pub fn as_none_connection_metadata( &self, ) -> Result<&NoneConnectionMetadata, &Self>
Tries to convert the enum instance into NoneConnectionMetadata, extracting the inner NoneConnectionMetadata.
Returns Err(&Self) if it can’t be converted.
Sourcepub fn is_none_connection_metadata(&self) -> bool
pub fn is_none_connection_metadata(&self) -> bool
Returns true if this is a NoneConnectionMetadata.
Sourcepub fn is_unknown(&self) -> bool
pub fn is_unknown(&self) -> bool
Returns true if the enum instance is the Unknown variant.
Trait Implementations§
Source§impl Clone for AuthenticationMetadata
impl Clone for AuthenticationMetadata
Source§fn clone(&self) -> AuthenticationMetadata
fn clone(&self) -> AuthenticationMetadata
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for AuthenticationMetadata
impl Debug for AuthenticationMetadata
Source§impl PartialEq for AuthenticationMetadata
impl PartialEq for AuthenticationMetadata
impl StructuralPartialEq for AuthenticationMetadata
Auto Trait Implementations§
impl Freeze for AuthenticationMetadata
impl RefUnwindSafe for AuthenticationMetadata
impl Send for AuthenticationMetadata
impl Sync for AuthenticationMetadata
impl Unpin for AuthenticationMetadata
impl UnwindSafe for AuthenticationMetadata
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);