#[non_exhaustive]pub struct AuthorizerDescription {
pub authorizer_name: Option<String>,
pub authorizer_arn: Option<String>,
pub authorizer_function_arn: Option<String>,
pub token_key_name: Option<String>,
pub token_signing_public_keys: Option<HashMap<String, String>>,
pub status: Option<AuthorizerStatus>,
pub creation_date: Option<DateTime>,
pub last_modified_date: Option<DateTime>,
pub signing_disabled: Option<bool>,
pub enable_caching_for_http: Option<bool>,
}
Expand description
The authorizer description.
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.The authorizer name.
The authorizer ARN.
The authorizer's Lambda function ARN.
token_key_name: Option<String>
The key used to extract the token from the HTTP headers.
token_signing_public_keys: Option<HashMap<String, String>>
The public keys used to validate the token signature returned by your custom authentication service.
status: Option<AuthorizerStatus>
The status of the authorizer.
creation_date: Option<DateTime>
The UNIX timestamp of when the authorizer was created.
last_modified_date: Option<DateTime>
The UNIX timestamp of when the authorizer was last updated.
signing_disabled: Option<bool>
Specifies whether IoT validates the token signature in an authorization request.
enable_caching_for_http: Option<bool>
When true
, the result from the authorizer’s Lambda function is cached for the time specified in refreshAfterInSeconds
. The cached result is used while the device reuses the same HTTP connection.
Implementations§
Source§impl AuthorizerDescription
impl AuthorizerDescription
The authorizer name.
The authorizer ARN.
The authorizer's Lambda function ARN.
Sourcepub fn token_key_name(&self) -> Option<&str>
pub fn token_key_name(&self) -> Option<&str>
The key used to extract the token from the HTTP headers.
Sourcepub fn token_signing_public_keys(&self) -> Option<&HashMap<String, String>>
pub fn token_signing_public_keys(&self) -> Option<&HashMap<String, String>>
The public keys used to validate the token signature returned by your custom authentication service.
Sourcepub fn status(&self) -> Option<&AuthorizerStatus>
pub fn status(&self) -> Option<&AuthorizerStatus>
The status of the authorizer.
Sourcepub fn creation_date(&self) -> Option<&DateTime>
pub fn creation_date(&self) -> Option<&DateTime>
The UNIX timestamp of when the authorizer was created.
Sourcepub fn last_modified_date(&self) -> Option<&DateTime>
pub fn last_modified_date(&self) -> Option<&DateTime>
The UNIX timestamp of when the authorizer was last updated.
Sourcepub fn signing_disabled(&self) -> Option<bool>
pub fn signing_disabled(&self) -> Option<bool>
Specifies whether IoT validates the token signature in an authorization request.
Sourcepub fn enable_caching_for_http(&self) -> Option<bool>
pub fn enable_caching_for_http(&self) -> Option<bool>
When true
, the result from the authorizer’s Lambda function is cached for the time specified in refreshAfterInSeconds
. The cached result is used while the device reuses the same HTTP connection.
Source§impl AuthorizerDescription
impl AuthorizerDescription
Sourcepub fn builder() -> AuthorizerDescriptionBuilder
pub fn builder() -> AuthorizerDescriptionBuilder
Creates a new builder-style object to manufacture AuthorizerDescription
.
Trait Implementations§
Source§impl Clone for AuthorizerDescription
impl Clone for AuthorizerDescription
Source§fn clone(&self) -> AuthorizerDescription
fn clone(&self) -> AuthorizerDescription
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 AuthorizerDescription
impl Debug for AuthorizerDescription
Source§impl PartialEq for AuthorizerDescription
impl PartialEq for AuthorizerDescription
impl StructuralPartialEq for AuthorizerDescription
Auto Trait Implementations§
impl Freeze for AuthorizerDescription
impl RefUnwindSafe for AuthorizerDescription
impl Send for AuthorizerDescription
impl Sync for AuthorizerDescription
impl Unpin for AuthorizerDescription
impl UnwindSafe for AuthorizerDescription
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);