pub struct RuntimeComponentsBuilder { /* private fields */ }
client
only.Expand description
Builder for RuntimeComponents
.
Implementations§
source§impl RuntimeComponentsBuilder
impl RuntimeComponentsBuilder
sourcepub const fn new(name: &'static str) -> Self
pub const fn new(name: &'static str) -> Self
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: &Self) -> Self
pub fn merge_from(self, other: &Self) -> Self
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,
) -> Self
pub fn from_runtime_components( rc: RuntimeComponents, builder_name: &'static str, ) -> Self
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 Self
pub fn set_auth_scheme_option_resolver( &mut self, auth_scheme_option_resolver: Option<impl ResolveAuthSchemeOptions + 'static>, ) -> &mut Self
Sets the auth scheme option resolver.
sourcepub fn with_auth_scheme_option_resolver(
self,
auth_scheme_option_resolver: Option<impl ResolveAuthSchemeOptions + 'static>,
) -> Self
pub fn with_auth_scheme_option_resolver( self, auth_scheme_option_resolver: Option<impl ResolveAuthSchemeOptions + 'static>, ) -> Self
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 Self
pub fn set_http_client( &mut self, connector: Option<impl HttpClient + 'static>, ) -> &mut Self
Sets the HTTP client.
sourcepub fn with_http_client(
self,
connector: Option<impl HttpClient + 'static>,
) -> Self
pub fn with_http_client( self, connector: Option<impl HttpClient + 'static>, ) -> Self
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 Self
pub fn set_endpoint_resolver( &mut self, endpoint_resolver: Option<impl ResolveEndpoint + 'static>, ) -> &mut Self
Sets the endpoint resolver.
sourcepub fn with_endpoint_resolver(
self,
endpoint_resolver: Option<impl ResolveEndpoint + 'static>,
) -> Self
pub fn with_endpoint_resolver( self, endpoint_resolver: Option<impl ResolveEndpoint + 'static>, ) -> Self
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 Self
pub fn push_auth_scheme( &mut self, auth_scheme: impl AuthScheme + 'static, ) -> &mut Self
Adds an auth scheme.
sourcepub fn with_auth_scheme(self, auth_scheme: impl AuthScheme + 'static) -> Self
pub fn with_auth_scheme(self, auth_scheme: impl AuthScheme + 'static) -> Self
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 Self
pub fn set_identity_cache( &mut self, identity_cache: Option<impl ResolveCachedIdentity + 'static>, ) -> &mut Self
Sets the identity cache.
sourcepub fn with_identity_cache(
self,
identity_cache: Option<impl ResolveCachedIdentity + 'static>,
) -> Self
pub fn with_identity_cache( self, identity_cache: Option<impl ResolveCachedIdentity + 'static>, ) -> Self
Sets the identity cache.
sourcepub fn push_identity_resolver(
&mut self,
scheme_id: AuthSchemeId,
identity_resolver: impl ResolveIdentity + 'static,
) -> &mut Self
👎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 Self
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 Self
pub fn set_identity_resolver( &mut self, scheme_id: AuthSchemeId, identity_resolver: impl ResolveIdentity + 'static, ) -> &mut Self
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,
) -> Self
pub fn with_identity_resolver( self, scheme_id: AuthSchemeId, identity_resolver: impl ResolveIdentity + 'static, ) -> Self
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 Self
pub fn extend_interceptors( &mut self, interceptors: impl Iterator<Item = SharedInterceptor>, ) -> &mut Self
Adds all the given interceptors.
sourcepub fn push_interceptor(
&mut self,
interceptor: impl Intercept + 'static,
) -> &mut Self
pub fn push_interceptor( &mut self, interceptor: impl Intercept + 'static, ) -> &mut Self
Adds an interceptor.
sourcepub fn with_interceptor(self, interceptor: impl Intercept + 'static) -> Self
pub fn with_interceptor(self, interceptor: impl Intercept + 'static) -> Self
Adds an interceptor.
sourcepub fn set_interceptors(
&mut self,
interceptors: impl Iterator<Item = SharedInterceptor>,
) -> &mut Self
pub fn set_interceptors( &mut self, interceptors: impl Iterator<Item = SharedInterceptor>, ) -> &mut Self
Directly sets the interceptors and clears out any that were previously pushed.
sourcepub fn with_interceptors(
self,
interceptors: impl Iterator<Item = SharedInterceptor>,
) -> Self
pub fn with_interceptors( self, interceptors: impl Iterator<Item = SharedInterceptor>, ) -> Self
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 Self
pub fn extend_retry_classifiers( &mut self, retry_classifiers: impl Iterator<Item = SharedRetryClassifier>, ) -> &mut Self
Adds all the given retry classifiers.
sourcepub fn push_retry_classifier(
&mut self,
retry_classifier: impl ClassifyRetry + 'static,
) -> &mut Self
pub fn push_retry_classifier( &mut self, retry_classifier: impl ClassifyRetry + 'static, ) -> &mut Self
Adds a retry_classifier.
sourcepub fn with_retry_classifier(
self,
retry_classifier: impl ClassifyRetry + 'static,
) -> Self
pub fn with_retry_classifier( self, retry_classifier: impl ClassifyRetry + 'static, ) -> Self
Adds a retry_classifier.
sourcepub fn set_retry_classifiers(
&mut self,
retry_classifiers: impl Iterator<Item = SharedRetryClassifier>,
) -> &mut Self
pub fn set_retry_classifiers( &mut self, retry_classifiers: impl Iterator<Item = SharedRetryClassifier>, ) -> &mut Self
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 Self
pub fn set_retry_strategy( &mut self, retry_strategy: Option<impl RetryStrategy + 'static>, ) -> &mut Self
Sets the retry strategy.
sourcepub fn with_retry_strategy(
self,
retry_strategy: Option<impl RetryStrategy + 'static>,
) -> Self
pub fn with_retry_strategy( self, retry_strategy: Option<impl RetryStrategy + 'static>, ) -> Self
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 Self
pub fn set_sleep_impl( &mut self, sleep_impl: Option<SharedAsyncSleep>, ) -> &mut Self
Sets the async sleep implementation.
sourcepub fn with_sleep_impl(
self,
sleep_impl: Option<impl AsyncSleep + 'static>,
) -> Self
pub fn with_sleep_impl( self, sleep_impl: Option<impl AsyncSleep + 'static>, ) -> Self
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 Self
pub fn set_time_source( &mut self, time_source: Option<SharedTimeSource>, ) -> &mut Self
Sets the time source.
sourcepub fn with_time_source(
self,
time_source: Option<impl TimeSource + 'static>,
) -> Self
pub fn with_time_source( self, time_source: Option<impl TimeSource + 'static>, ) -> Self
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 Self
pub fn extend_config_validators( &mut self, config_validators: impl Iterator<Item = SharedConfigValidator>, ) -> &mut Self
Adds all the given config validators.
sourcepub fn push_config_validator(
&mut self,
config_validator: impl ValidateConfig + 'static,
) -> &mut Self
pub fn push_config_validator( &mut self, config_validator: impl ValidateConfig + 'static, ) -> &mut Self
Adds a config validator.
sourcepub fn with_config_validator(
self,
config_validator: impl ValidateConfig + 'static,
) -> Self
pub fn with_config_validator( self, config_validator: impl ValidateConfig + 'static, ) -> Self
Adds a config validator.
sourcepub fn validate_base_client_config(
&self,
cfg: &ConfigBag,
) -> Result<(), BoxError>
pub fn validate_base_client_config( &self, cfg: &ConfigBag, ) -> Result<(), BoxError>
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
.
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§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§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 more