pub struct Config { /* private fields */ }
Expand description
Configuration for a aws_sdk_cloudwatchlogs service client.
Service configuration allows for customization of endpoints, region, credentials providers,
and retry configuration. Generally, it is constructed automatically for you from a shared
configuration loaded by the aws-config
crate. For example:
// Load a shared config from the environment
let shared_config = aws_config::from_env().load().await;
// The client constructor automatically converts the shared config into the service config
let client = Client::new(&shared_config);
The service config can also be constructed manually using its builder.
Implementations§
Source§impl Config
impl Config
Sourcepub fn to_builder(&self) -> Builder
pub fn to_builder(&self) -> Builder
Converts this config back into a builder so that it can be tweaked.
Sourcepub fn stalled_stream_protection(
&self,
) -> Option<&StalledStreamProtectionConfig>
pub fn stalled_stream_protection( &self, ) -> Option<&StalledStreamProtectionConfig>
Return a reference to the stalled stream protection configuration contained in this config, if any.
Sourcepub fn http_client(&self) -> Option<SharedHttpClient>
pub fn http_client(&self) -> Option<SharedHttpClient>
Return the SharedHttpClient
to use when making requests, if any.
Sourcepub fn endpoint_resolver(&self) -> SharedEndpointResolver
pub fn endpoint_resolver(&self) -> SharedEndpointResolver
Returns the endpoint resolver.
Sourcepub fn retry_config(&self) -> Option<&RetryConfig>
pub fn retry_config(&self) -> Option<&RetryConfig>
Return a reference to the retry configuration contained in this config, if any.
Sourcepub fn sleep_impl(&self) -> Option<SharedAsyncSleep>
pub fn sleep_impl(&self) -> Option<SharedAsyncSleep>
Return a cloned shared async sleep implementation from this config, if any.
Sourcepub fn timeout_config(&self) -> Option<&TimeoutConfig>
pub fn timeout_config(&self) -> Option<&TimeoutConfig>
Return a reference to the timeout configuration contained in this config, if any.
Sourcepub fn retry_partition(&self) -> Option<&RetryPartition>
pub fn retry_partition(&self) -> Option<&RetryPartition>
Returns a reference to the retry partition contained in this config, if any.
WARNING: This method is unstable and may be removed at any time. Do not rely on this method for anything!
Sourcepub fn identity_cache(&self) -> Option<SharedIdentityCache>
pub fn identity_cache(&self) -> Option<SharedIdentityCache>
Returns the configured identity cache for auth.
Sourcepub fn interceptors(&self) -> impl Iterator<Item = SharedInterceptor> + '_
pub fn interceptors(&self) -> impl Iterator<Item = SharedInterceptor> + '_
Returns interceptors currently registered by the user.
Sourcepub fn time_source(&self) -> Option<SharedTimeSource>
pub fn time_source(&self) -> Option<SharedTimeSource>
Return time source used for this service.
Sourcepub fn retry_classifiers(
&self,
) -> impl Iterator<Item = SharedRetryClassifier> + '_
pub fn retry_classifiers( &self, ) -> impl Iterator<Item = SharedRetryClassifier> + '_
Returns retry classifiers currently registered by the user.
Sourcepub fn app_name(&self) -> Option<&AppName>
pub fn app_name(&self) -> Option<&AppName>
Returns the name of the app that is using the client, if it was provided.
This optional name is used to identify the application in the user agent that gets sent along with requests.
Sourcepub fn invocation_id_generator(&self) -> Option<SharedInvocationIdGenerator>
pub fn invocation_id_generator(&self) -> Option<SharedInvocationIdGenerator>
Returns the invocation ID generator if one was given in config.
The invocation ID generator generates ID values for the amz-sdk-invocation-id
header. By default, this will be a random UUID. Overriding it may be useful in tests that examine the HTTP request and need to be deterministic.
Sourcepub fn new(config: &SdkConfig) -> Self
pub fn new(config: &SdkConfig) -> Self
Creates a new service config from a shared config
.
Sourcepub fn signing_name(&self) -> &'static str
pub fn signing_name(&self) -> &'static str
The signature version 4 service signing name to use in the credential scope when signing requests.
The signing service may be overridden by the Endpoint
, or by specifying a custom
SigningName
during operation construction
Sourcepub fn credentials_provider(&self) -> Option<SharedCredentialsProvider>
👎Deprecated: This function was intended to be removed, and has been broken since release-2023-11-15 as it always returns a None
. Do not use.
pub fn credentials_provider(&self) -> Option<SharedCredentialsProvider>
None
. Do not use.This function was intended to be removed, and has been broken since release-2023-11-15 as it always returns a None
. Do not use.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Config
impl !RefUnwindSafe for Config
impl Send for Config
impl Sync for Config
impl Unpin for Config
impl !UnwindSafe for Config
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>
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);