pub struct RuntimeComponentsBuilder { /* private fields */ }
Expand description
Builder for RuntimeComponents
.
Implementations§
Source§impl RuntimeComponentsBuilder
impl RuntimeComponentsBuilder
Sourcepub const fn new(name: &'static str) -> RuntimeComponentsBuilder
pub const fn new(name: &'static str) -> RuntimeComponentsBuilder
Creates a new builder.
Since multiple builders are merged together to make the final RuntimeComponents
,
all components added by this builder are associated with the given name
so that
the origin of a component can be easily found when debugging.
Sourcepub fn merge_from(
self,
other: &RuntimeComponentsBuilder,
) -> RuntimeComponentsBuilder
pub fn merge_from( self, other: &RuntimeComponentsBuilder, ) -> RuntimeComponentsBuilder
Merge in components from another builder.
Sourcepub fn build(self) -> Result<RuntimeComponents, BuildError>
pub fn build(self) -> Result<RuntimeComponents, BuildError>
Builds RuntimeComponents
from this builder.
Source§impl RuntimeComponentsBuilder
impl RuntimeComponentsBuilder
Sourcepub fn from_runtime_components(
rc: RuntimeComponents,
builder_name: &'static str,
) -> RuntimeComponentsBuilder
pub fn from_runtime_components( rc: RuntimeComponents, builder_name: &'static str, ) -> RuntimeComponentsBuilder
Creates a new RuntimeComponentsBuilder
, inheriting all fields from the given
RuntimeComponents
.
Sourcepub fn auth_scheme_option_resolver(
&self,
) -> Option<SharedAuthSchemeOptionResolver>
pub fn auth_scheme_option_resolver( &self, ) -> Option<SharedAuthSchemeOptionResolver>
Returns the auth scheme option resolver.
Sourcepub fn set_auth_scheme_option_resolver(
&mut self,
auth_scheme_option_resolver: Option<impl ResolveAuthSchemeOptions + 'static>,
) -> &mut RuntimeComponentsBuilder
pub fn set_auth_scheme_option_resolver( &mut self, auth_scheme_option_resolver: Option<impl ResolveAuthSchemeOptions + 'static>, ) -> &mut RuntimeComponentsBuilder
Sets the auth scheme option resolver.
Sourcepub fn with_auth_scheme_option_resolver(
self,
auth_scheme_option_resolver: Option<impl ResolveAuthSchemeOptions + 'static>,
) -> RuntimeComponentsBuilder
pub fn with_auth_scheme_option_resolver( self, auth_scheme_option_resolver: Option<impl ResolveAuthSchemeOptions + 'static>, ) -> RuntimeComponentsBuilder
Sets the auth scheme option resolver.
Sourcepub fn http_client(&self) -> Option<SharedHttpClient>
pub fn http_client(&self) -> Option<SharedHttpClient>
Returns the HTTP client.
Sourcepub fn set_http_client(
&mut self,
connector: Option<impl HttpClient + 'static>,
) -> &mut RuntimeComponentsBuilder
pub fn set_http_client( &mut self, connector: Option<impl HttpClient + 'static>, ) -> &mut RuntimeComponentsBuilder
Sets the HTTP client.
Sourcepub fn with_http_client(
self,
connector: Option<impl HttpClient + 'static>,
) -> RuntimeComponentsBuilder
pub fn with_http_client( self, connector: Option<impl HttpClient + 'static>, ) -> RuntimeComponentsBuilder
Sets the HTTP client.
Sourcepub fn endpoint_resolver(&self) -> Option<SharedEndpointResolver>
pub fn endpoint_resolver(&self) -> Option<SharedEndpointResolver>
Returns the endpoint resolver.
Sourcepub fn set_endpoint_resolver(
&mut self,
endpoint_resolver: Option<impl ResolveEndpoint + 'static>,
) -> &mut RuntimeComponentsBuilder
pub fn set_endpoint_resolver( &mut self, endpoint_resolver: Option<impl ResolveEndpoint + 'static>, ) -> &mut RuntimeComponentsBuilder
Sets the endpoint resolver.
Sourcepub fn with_endpoint_resolver(
self,
endpoint_resolver: Option<impl ResolveEndpoint + 'static>,
) -> RuntimeComponentsBuilder
pub fn with_endpoint_resolver( self, endpoint_resolver: Option<impl ResolveEndpoint + 'static>, ) -> RuntimeComponentsBuilder
Sets the endpoint resolver.
Sourcepub fn auth_schemes(&self) -> impl Iterator<Item = SharedAuthScheme>
pub fn auth_schemes(&self) -> impl Iterator<Item = SharedAuthScheme>
Returns the auth schemes.
Sourcepub fn push_auth_scheme(
&mut self,
auth_scheme: impl AuthScheme + 'static,
) -> &mut RuntimeComponentsBuilder
pub fn push_auth_scheme( &mut self, auth_scheme: impl AuthScheme + 'static, ) -> &mut RuntimeComponentsBuilder
Adds an auth scheme.
Sourcepub fn with_auth_scheme(
self,
auth_scheme: impl AuthScheme + 'static,
) -> RuntimeComponentsBuilder
pub fn with_auth_scheme( self, auth_scheme: impl AuthScheme + 'static, ) -> RuntimeComponentsBuilder
Adds an auth scheme.
Sourcepub fn identity_cache(&self) -> Option<SharedIdentityCache>
pub fn identity_cache(&self) -> Option<SharedIdentityCache>
Returns the identity cache.
Sourcepub fn set_identity_cache(
&mut self,
identity_cache: Option<impl ResolveCachedIdentity + 'static>,
) -> &mut RuntimeComponentsBuilder
pub fn set_identity_cache( &mut self, identity_cache: Option<impl ResolveCachedIdentity + 'static>, ) -> &mut RuntimeComponentsBuilder
Sets the identity cache.
Sourcepub fn with_identity_cache(
self,
identity_cache: Option<impl ResolveCachedIdentity + 'static>,
) -> RuntimeComponentsBuilder
pub fn with_identity_cache( self, identity_cache: Option<impl ResolveCachedIdentity + 'static>, ) -> RuntimeComponentsBuilder
Sets the identity cache.
Sourcepub fn push_identity_resolver(
&mut self,
scheme_id: AuthSchemeId,
identity_resolver: impl ResolveIdentity + 'static,
) -> &mut RuntimeComponentsBuilder
👎Deprecated: This method is broken since it does not replace an existing identity resolver of the given auth scheme ID. Use set_identity_resolver
instead.
pub fn push_identity_resolver( &mut self, scheme_id: AuthSchemeId, identity_resolver: impl ResolveIdentity + 'static, ) -> &mut RuntimeComponentsBuilder
set_identity_resolver
instead.This method is broken since it does not replace an existing identity resolver of the given auth scheme ID.
Use set_identity_resolver
instead.
Sourcepub fn set_identity_resolver(
&mut self,
scheme_id: AuthSchemeId,
identity_resolver: impl ResolveIdentity + 'static,
) -> &mut RuntimeComponentsBuilder
pub fn set_identity_resolver( &mut self, scheme_id: AuthSchemeId, identity_resolver: impl ResolveIdentity + 'static, ) -> &mut RuntimeComponentsBuilder
Sets the identity resolver for a given scheme_id
.
If there is already an identity resolver for that scheme_id
, this method will replace
the existing one with the passed-in identity_resolver
.
Sourcepub fn with_identity_resolver(
self,
scheme_id: AuthSchemeId,
identity_resolver: impl ResolveIdentity + 'static,
) -> RuntimeComponentsBuilder
pub fn with_identity_resolver( self, scheme_id: AuthSchemeId, identity_resolver: impl ResolveIdentity + 'static, ) -> RuntimeComponentsBuilder
Adds an identity resolver.
Sourcepub fn interceptors(&self) -> impl Iterator<Item = SharedInterceptor>
pub fn interceptors(&self) -> impl Iterator<Item = SharedInterceptor>
Returns the interceptors.
Sourcepub fn extend_interceptors(
&mut self,
interceptors: impl Iterator<Item = SharedInterceptor>,
) -> &mut RuntimeComponentsBuilder
pub fn extend_interceptors( &mut self, interceptors: impl Iterator<Item = SharedInterceptor>, ) -> &mut RuntimeComponentsBuilder
Adds all the given interceptors.
Sourcepub fn push_interceptor(
&mut self,
interceptor: impl Intercept + 'static,
) -> &mut RuntimeComponentsBuilder
pub fn push_interceptor( &mut self, interceptor: impl Intercept + 'static, ) -> &mut RuntimeComponentsBuilder
Adds an interceptor.
Sourcepub fn with_interceptor(
self,
interceptor: impl Intercept + 'static,
) -> RuntimeComponentsBuilder
pub fn with_interceptor( self, interceptor: impl Intercept + 'static, ) -> RuntimeComponentsBuilder
Adds an interceptor.
Sourcepub fn set_interceptors(
&mut self,
interceptors: impl Iterator<Item = SharedInterceptor>,
) -> &mut RuntimeComponentsBuilder
pub fn set_interceptors( &mut self, interceptors: impl Iterator<Item = SharedInterceptor>, ) -> &mut RuntimeComponentsBuilder
Directly sets the interceptors and clears out any that were previously pushed.
Sourcepub fn with_interceptors(
self,
interceptors: impl Iterator<Item = SharedInterceptor>,
) -> RuntimeComponentsBuilder
pub fn with_interceptors( self, interceptors: impl Iterator<Item = SharedInterceptor>, ) -> RuntimeComponentsBuilder
Directly sets the interceptors and clears out any that were previously pushed.
Sourcepub fn retry_classifiers(&self) -> impl Iterator<Item = SharedRetryClassifier>
pub fn retry_classifiers(&self) -> impl Iterator<Item = SharedRetryClassifier>
Returns the retry classifiers.
Sourcepub fn extend_retry_classifiers(
&mut self,
retry_classifiers: impl Iterator<Item = SharedRetryClassifier>,
) -> &mut RuntimeComponentsBuilder
pub fn extend_retry_classifiers( &mut self, retry_classifiers: impl Iterator<Item = SharedRetryClassifier>, ) -> &mut RuntimeComponentsBuilder
Adds all the given retry classifiers.
Sourcepub fn push_retry_classifier(
&mut self,
retry_classifier: impl ClassifyRetry + 'static,
) -> &mut RuntimeComponentsBuilder
pub fn push_retry_classifier( &mut self, retry_classifier: impl ClassifyRetry + 'static, ) -> &mut RuntimeComponentsBuilder
Adds a retry_classifier.
Sourcepub fn with_retry_classifier(
self,
retry_classifier: impl ClassifyRetry + 'static,
) -> RuntimeComponentsBuilder
pub fn with_retry_classifier( self, retry_classifier: impl ClassifyRetry + 'static, ) -> RuntimeComponentsBuilder
Adds a retry_classifier.
Sourcepub fn set_retry_classifiers(
&mut self,
retry_classifiers: impl Iterator<Item = SharedRetryClassifier>,
) -> &mut RuntimeComponentsBuilder
pub fn set_retry_classifiers( &mut self, retry_classifiers: impl Iterator<Item = SharedRetryClassifier>, ) -> &mut RuntimeComponentsBuilder
Directly sets the retry_classifiers and clears out any that were previously pushed.
Sourcepub fn retry_strategy(&self) -> Option<SharedRetryStrategy>
pub fn retry_strategy(&self) -> Option<SharedRetryStrategy>
Returns the retry strategy.
Sourcepub fn set_retry_strategy(
&mut self,
retry_strategy: Option<impl RetryStrategy + 'static>,
) -> &mut RuntimeComponentsBuilder
pub fn set_retry_strategy( &mut self, retry_strategy: Option<impl RetryStrategy + 'static>, ) -> &mut RuntimeComponentsBuilder
Sets the retry strategy.
Sourcepub fn with_retry_strategy(
self,
retry_strategy: Option<impl RetryStrategy + 'static>,
) -> RuntimeComponentsBuilder
pub fn with_retry_strategy( self, retry_strategy: Option<impl RetryStrategy + 'static>, ) -> RuntimeComponentsBuilder
Sets the retry strategy.
Sourcepub fn sleep_impl(&self) -> Option<SharedAsyncSleep>
pub fn sleep_impl(&self) -> Option<SharedAsyncSleep>
Returns the async sleep implementation.
Sourcepub fn set_sleep_impl(
&mut self,
sleep_impl: Option<SharedAsyncSleep>,
) -> &mut RuntimeComponentsBuilder
pub fn set_sleep_impl( &mut self, sleep_impl: Option<SharedAsyncSleep>, ) -> &mut RuntimeComponentsBuilder
Sets the async sleep implementation.
Sourcepub fn with_sleep_impl(
self,
sleep_impl: Option<impl AsyncSleep + 'static>,
) -> RuntimeComponentsBuilder
pub fn with_sleep_impl( self, sleep_impl: Option<impl AsyncSleep + 'static>, ) -> RuntimeComponentsBuilder
Sets the async sleep implementation.
Sourcepub fn time_source(&self) -> Option<SharedTimeSource>
pub fn time_source(&self) -> Option<SharedTimeSource>
Returns the time source.
Sourcepub fn set_time_source(
&mut self,
time_source: Option<SharedTimeSource>,
) -> &mut RuntimeComponentsBuilder
pub fn set_time_source( &mut self, time_source: Option<SharedTimeSource>, ) -> &mut RuntimeComponentsBuilder
Sets the time source.
Sourcepub fn with_time_source(
self,
time_source: Option<impl TimeSource + 'static>,
) -> RuntimeComponentsBuilder
pub fn with_time_source( self, time_source: Option<impl TimeSource + 'static>, ) -> RuntimeComponentsBuilder
Sets the time source.
Sourcepub fn config_validators(&self) -> impl Iterator<Item = SharedConfigValidator>
pub fn config_validators(&self) -> impl Iterator<Item = SharedConfigValidator>
Returns the config validators.
Sourcepub fn extend_config_validators(
&mut self,
config_validators: impl Iterator<Item = SharedConfigValidator>,
) -> &mut RuntimeComponentsBuilder
pub fn extend_config_validators( &mut self, config_validators: impl Iterator<Item = SharedConfigValidator>, ) -> &mut RuntimeComponentsBuilder
Adds all the given config validators.
Sourcepub fn push_config_validator(
&mut self,
config_validator: impl ValidateConfig + 'static,
) -> &mut RuntimeComponentsBuilder
pub fn push_config_validator( &mut self, config_validator: impl ValidateConfig + 'static, ) -> &mut RuntimeComponentsBuilder
Adds a config validator.
Sourcepub fn with_config_validator(
self,
config_validator: impl ValidateConfig + 'static,
) -> RuntimeComponentsBuilder
pub fn with_config_validator( self, config_validator: impl ValidateConfig + 'static, ) -> RuntimeComponentsBuilder
Adds a config validator.
Sourcepub fn validate_base_client_config(
&self,
cfg: &ConfigBag,
) -> Result<(), Box<dyn Error + Sync + Send>>
pub fn validate_base_client_config( &self, cfg: &ConfigBag, ) -> Result<(), Box<dyn Error + Sync + Send>>
Validate the base client configuration.
This is intended to be called internally by the client.
Sourcepub fn into_time_components(self) -> TimeComponents
pub fn into_time_components(self) -> TimeComponents
Converts this builder into TimeComponents
.
Source§impl RuntimeComponentsBuilder
impl RuntimeComponentsBuilder
Sourcepub fn for_tests() -> RuntimeComponentsBuilder
Available on crate feature test-util
only.
pub fn for_tests() -> RuntimeComponentsBuilder
test-util
only.Creates a runtime components builder with all the required components filled in with fake (panicking) implementations.
Trait Implementations§
Source§impl Clone for RuntimeComponentsBuilder
impl Clone for RuntimeComponentsBuilder
Source§fn clone(&self) -> RuntimeComponentsBuilder
fn clone(&self) -> RuntimeComponentsBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for RuntimeComponentsBuilder
impl !RefUnwindSafe for RuntimeComponentsBuilder
impl Send for RuntimeComponentsBuilder
impl Sync for RuntimeComponentsBuilder
impl Unpin for RuntimeComponentsBuilder
impl !UnwindSafe for RuntimeComponentsBuilder
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);