pub struct RuntimeComponentsBuilder { /* private fields */ }
Expand description

Builder for RuntimeComponents.

Implementations§

source§

impl RuntimeComponentsBuilder

source

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.

source

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

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, ) -> RuntimeComponentsBuilder

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 RuntimeComponentsBuilder

Sets the auth scheme option resolver.

source

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

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 RuntimeComponentsBuilder

Sets the HTTP client.

source

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

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 RuntimeComponentsBuilder

Sets the endpoint resolver.

source

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

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 RuntimeComponentsBuilder

Adds an auth scheme.

source

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

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 RuntimeComponentsBuilder

Sets the identity cache.

source

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

Sets the identity cache.

source

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

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

source

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

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 RuntimeComponentsBuilder

Adds all the given interceptors.

source

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

Adds an interceptor.

source

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

Adds an interceptor.

source

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.

source

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

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 RuntimeComponentsBuilder

Adds all the given retry classifiers.

source

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

Adds a retry_classifier.

source

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

Adds a retry_classifier.

source

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.

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 RuntimeComponentsBuilder

Sets the retry strategy.

source

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

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 RuntimeComponentsBuilder

Sets the async sleep implementation.

source

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

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 RuntimeComponentsBuilder

Sets the time source.

source

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

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 RuntimeComponentsBuilder

Adds all the given config validators.

source

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

Adds a config validator.

source

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

Adds a config validator.

source

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.

source

pub fn into_time_components(self) -> TimeComponents

Converts this builder into TimeComponents.

source§

impl RuntimeComponentsBuilder

source

pub fn for_tests() -> RuntimeComponentsBuilder

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<(), Error>

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§

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.

source§

impl<T> Instrument for T

source§

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

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

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> Paint for T
where T: ?Sized,

source§

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 primary(&self) -> Painted<&T>

Returns self with the fg() set to Color::Primary.

§Example
println!("{}", value.primary());
source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to Color::Fixed.

§Example
println!("{}", value.fixed(color));
source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to Color::Rgb.

§Example
println!("{}", value.rgb(r, g, b));
source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to Color::Black.

§Example
println!("{}", value.black());
source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to Color::Red.

§Example
println!("{}", value.red());
source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to Color::Green.

§Example
println!("{}", value.green());
source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to Color::Yellow.

§Example
println!("{}", value.yellow());
source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to Color::Blue.

§Example
println!("{}", value.blue());
source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to Color::Magenta.

§Example
println!("{}", value.magenta());
source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to Color::Cyan.

§Example
println!("{}", value.cyan());
source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to Color::White.

§Example
println!("{}", value.white());
source§

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>

Returns self with the fg() set to Color::BrightRed.

§Example
println!("{}", value.bright_red());
source§

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>

Returns self with the fg() set to Color::BrightYellow.

§Example
println!("{}", value.bright_yellow());
source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightBlue.

§Example
println!("{}", value.bright_blue());
source§

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>

Returns self with the fg() set to Color::BrightCyan.

§Example
println!("{}", value.bright_cyan());
source§

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>

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>

Returns self with the bg() set to Color::Primary.

§Example
println!("{}", value.on_primary());
source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to Color::Fixed.

§Example
println!("{}", value.on_fixed(color));
source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to Color::Rgb.

§Example
println!("{}", value.on_rgb(r, g, b));
source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to Color::Black.

§Example
println!("{}", value.on_black());
source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to Color::Red.

§Example
println!("{}", value.on_red());
source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to Color::Green.

§Example
println!("{}", value.on_green());
source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to Color::Yellow.

§Example
println!("{}", value.on_yellow());
source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to Color::Blue.

§Example
println!("{}", value.on_blue());
source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to Color::Magenta.

§Example
println!("{}", value.on_magenta());
source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to Color::Cyan.

§Example
println!("{}", value.on_cyan());
source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to Color::White.

§Example
println!("{}", value.on_white());
source§

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>

Returns self with the bg() set to Color::BrightRed.

§Example
println!("{}", value.on_bright_red());
source§

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>

Returns self with the bg() set to Color::BrightYellow.

§Example
println!("{}", value.on_bright_yellow());
source§

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>

Returns self with the bg() set to Color::BrightMagenta.

§Example
println!("{}", value.on_bright_magenta());
source§

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>

Returns self with the bg() set to Color::BrightWhite.

§Example
println!("{}", value.on_bright_white());
source§

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 bold(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Bold.

§Example
println!("{}", value.bold());
source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Dim.

§Example
println!("{}", value.dim());
source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Italic.

§Example
println!("{}", value.italic());
source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Underline.

§Example
println!("{}", value.underline());

Returns self with the attr() set to Attribute::Blink.

§Example
println!("{}", value.blink());

Returns self with the attr() set to Attribute::RapidBlink.

§Example
println!("{}", value.rapid_blink());
source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Invert.

§Example
println!("{}", value.invert());
source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Conceal.

§Example
println!("{}", value.conceal());
source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Strike.

§Example
println!("{}", value.strike());
source§

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 mask(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Mask.

§Example
println!("{}", value.mask());
source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Wrap.

§Example
println!("{}", value.wrap());
source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Linger.

§Example
println!("{}", value.linger());
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.

Returns self with the quirk() set to Quirk::Clear.

§Example
println!("{}", value.clear());
source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Resetting.

§Example
println!("{}", value.resetting());
source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Bright.

§Example
println!("{}", value.bright());
source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::OnBright.

§Example
println!("{}", value.on_bright());
source§

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);
source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
source§

impl<T> Same for T

source§

type Output = T

Should always be Self
source§

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

source§

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

source§

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

source§

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

impl<T> WithSubscriber for T

source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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