pub struct RuntimeComponentsBuilder { /* private fields */ }
Available on crate feature client only.
Expand description

Builder for RuntimeComponents.

Implementations§

source§

impl RuntimeComponentsBuilder

source

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.

source

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

Merge in components from another builder.

source

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

Builds RuntimeComponents from this builder.

source§

impl RuntimeComponentsBuilder

source

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

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

source

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

Returns the auth scheme option resolver.

source

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.

source

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

Sets the auth scheme option resolver.

source

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

Returns the HTTP client.

source

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

Sets the HTTP client.

source

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

Sets the HTTP client.

source

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

Returns the endpoint resolver.

source

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

Sets the endpoint resolver.

source

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

Sets the endpoint resolver.

source

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

Returns the auth schemes.

source

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

Adds an auth scheme.

source

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

Adds an auth scheme.

source

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

Returns the identity cache.

source

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

Sets the identity cache.

source

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

Sets the identity cache.

source

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.

source

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.

source

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

Adds an identity resolver.

source

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

Returns the interceptors.

source

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

Adds all the given interceptors.

source

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

Adds an interceptor.

source

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

Adds an interceptor.

source

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.

source

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

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

source

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

Returns the retry classifiers.

source

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

Adds all the given retry classifiers.

source

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

Adds a retry_classifier.

source

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

Adds a retry_classifier.

source

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.

source

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

Returns the retry strategy.

source

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

Sets the retry strategy.

source

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

Sets the retry strategy.

source

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

Returns the async sleep implementation.

source

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

Sets the async sleep implementation.

source

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

Sets the async sleep implementation.

source

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

Returns the time source.

source

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

Sets the time source.

source

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

Sets the time source.

source

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

Returns the config validators.

source

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

Adds all the given config validators.

source

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

Adds a config validator.

source

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

Adds a config validator.

source

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.

source

pub fn into_time_components(self) -> TimeComponents

Converts this builder into TimeComponents.

source§

impl RuntimeComponentsBuilder

source

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§

source§

impl Clone for RuntimeComponentsBuilder

source§

fn clone(&self) -> RuntimeComponentsBuilder

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for RuntimeComponentsBuilder

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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
source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more