Struct RuntimeComponentsBuilder

pub struct RuntimeComponentsBuilder { /* private fields */ }

Available on crate feature client only.

Builder for RuntimeComponents.

Implementations

impl RuntimeComponentsBuilder

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.

pub fn merge_from(self, other: &Self) -> Self

Merge in components from another builder.

pub fn build(self) -> Result<RuntimeComponents, BuildError>

Builds RuntimeComponents from this builder.

impl RuntimeComponentsBuilder

pub fn from_runtime_components( rc: RuntimeComponents, builder_name: &'static str, ) -> Self

Creates a new RuntimeComponentsBuilder, inheriting all fields from the given RuntimeComponents.

pub fn auth_scheme_option_resolver( &self, ) -> Option<SharedAuthSchemeOptionResolver>

Returns the auth scheme option resolver.

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.

pub fn with_auth_scheme_option_resolver( self, auth_scheme_option_resolver: Option<impl ResolveAuthSchemeOptions + 'static>, ) -> Self

Sets the auth scheme option resolver.

pub fn http_client(&self) -> Option<SharedHttpClient>

Returns the HTTP client.

pub fn set_http_client( &mut self, connector: Option<impl HttpClient + 'static>, ) -> &mut Self

Sets the HTTP client.

pub fn with_http_client( self, connector: Option<impl HttpClient + 'static>, ) -> Self

Sets the HTTP client.

pub fn endpoint_resolver(&self) -> Option<SharedEndpointResolver>

Returns the endpoint resolver.

pub fn set_endpoint_resolver( &mut self, endpoint_resolver: Option<impl ResolveEndpoint + 'static>, ) -> &mut Self

Sets the endpoint resolver.

pub fn with_endpoint_resolver( self, endpoint_resolver: Option<impl ResolveEndpoint + 'static>, ) -> Self

Sets the endpoint resolver.

pub fn auth_schemes(&self) -> impl Iterator<Item = SharedAuthScheme> + '_

Returns the auth schemes.

pub fn push_auth_scheme( &mut self, auth_scheme: impl AuthScheme + 'static, ) -> &mut Self

Adds an auth scheme.

pub fn with_auth_scheme(self, auth_scheme: impl AuthScheme + 'static) -> Self

Adds an auth scheme.

pub fn identity_cache(&self) -> Option<SharedIdentityCache>

Returns the identity cache.

pub fn set_identity_cache( &mut self, identity_cache: Option<impl ResolveCachedIdentity + 'static>, ) -> &mut Self

Sets the identity cache.

pub fn with_identity_cache( self, identity_cache: Option<impl ResolveCachedIdentity + 'static>, ) -> Self

Sets the identity cache.

pub 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.

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 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.

pub fn with_identity_resolver( self, scheme_id: AuthSchemeId, identity_resolver: impl ResolveIdentity + 'static, ) -> Self

Adds an identity resolver.

pub fn interceptors(&self) -> impl Iterator<Item = SharedInterceptor> + '_

Returns the interceptors.

pub fn extend_interceptors( &mut self, interceptors: impl Iterator<Item = SharedInterceptor>, ) -> &mut Self

Adds all the given interceptors.

pub fn push_interceptor( &mut self, interceptor: impl Intercept + 'static, ) -> &mut Self

Adds an interceptor.

pub fn with_interceptor(self, interceptor: impl Intercept + 'static) -> Self

Adds an interceptor.

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.

pub fn with_interceptors( self, interceptors: impl Iterator<Item = SharedInterceptor>, ) -> Self

Directly sets the interceptors and clears out any that were previously pushed.

pub fn retry_classifiers( &self, ) -> impl Iterator<Item = SharedRetryClassifier> + '_

Returns the retry classifiers.

pub fn extend_retry_classifiers( &mut self, retry_classifiers: impl Iterator<Item = SharedRetryClassifier>, ) -> &mut Self

Adds all the given retry classifiers.

pub fn push_retry_classifier( &mut self, retry_classifier: impl ClassifyRetry + 'static, ) -> &mut Self

Adds a retry_classifier.

pub fn with_retry_classifier( self, retry_classifier: impl ClassifyRetry + 'static, ) -> Self

Adds a retry_classifier.

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.

pub fn retry_strategy(&self) -> Option<SharedRetryStrategy>

Returns the retry strategy.

pub fn set_retry_strategy( &mut self, retry_strategy: Option<impl RetryStrategy + 'static>, ) -> &mut Self

Sets the retry strategy.

pub fn with_retry_strategy( self, retry_strategy: Option<impl RetryStrategy + 'static>, ) -> Self

Sets the retry strategy.

pub fn sleep_impl(&self) -> Option<SharedAsyncSleep>

Returns the async sleep implementation.

pub fn set_sleep_impl( &mut self, sleep_impl: Option<SharedAsyncSleep>, ) -> &mut Self

Sets the async sleep implementation.

pub fn with_sleep_impl( self, sleep_impl: Option<impl AsyncSleep + 'static>, ) -> Self

Sets the async sleep implementation.

pub fn time_source(&self) -> Option<SharedTimeSource>

Returns the time source.

pub fn set_time_source( &mut self, time_source: Option<SharedTimeSource>, ) -> &mut Self

Sets the time source.

pub fn with_time_source( self, time_source: Option<impl TimeSource + 'static>, ) -> Self

Sets the time source.

pub fn config_validators( &self, ) -> impl Iterator<Item = SharedConfigValidator> + '_

Returns the config validators.

pub fn extend_config_validators( &mut self, config_validators: impl Iterator<Item = SharedConfigValidator>, ) -> &mut Self

Adds all the given config validators.

pub fn push_config_validator( &mut self, config_validator: impl ValidateConfig + 'static, ) -> &mut Self

Adds a config validator.

pub fn with_config_validator( self, config_validator: impl ValidateConfig + 'static, ) -> Self

Adds a config validator.

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.

pub fn into_time_components(self) -> TimeComponents

Converts this builder into TimeComponents.

impl RuntimeComponentsBuilder

pub fn for_tests() -> Self

Available on crate feature test-util only.

Creates a runtime components builder with all the required components filled in with fake (panicking) implementations.

Trait Implementations

impl Clone for RuntimeComponentsBuilder

fn clone(&self) -> RuntimeComponentsBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RuntimeComponentsBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.