pub struct OperationBuilder<I = (), O = (), E = ()> { /* private fields */ }
client
only.Expand description
Builder for Operation
.
Implementations§
source§impl OperationBuilder<(), (), ()>
impl OperationBuilder<(), (), ()>
sourcepub fn new() -> Self
pub fn new() -> Self
Creates a new OperationBuilder
.
source§impl<I, O, E> OperationBuilder<I, O, E>
impl<I, O, E> OperationBuilder<I, O, E>
sourcepub fn service_name(self, service_name: impl Into<Cow<'static, str>>) -> Self
pub fn service_name(self, service_name: impl Into<Cow<'static, str>>) -> Self
Configures the service name for the builder.
sourcepub fn operation_name(
self,
operation_name: impl Into<Cow<'static, str>>,
) -> Self
pub fn operation_name( self, operation_name: impl Into<Cow<'static, str>>, ) -> Self
Configures the operation name for the builder.
sourcepub fn http_client(self, connector: impl HttpClient + 'static) -> Self
pub fn http_client(self, connector: impl HttpClient + 'static) -> Self
Configures the http client for the builder.
sourcepub fn endpoint_url(self, url: &str) -> Self
pub fn endpoint_url(self, url: &str) -> Self
Configures the endpoint URL for the builder.
sourcepub fn retry_classifier(
self,
retry_classifier: impl ClassifyRetry + 'static,
) -> Self
pub fn retry_classifier( self, retry_classifier: impl ClassifyRetry + 'static, ) -> Self
Configures the retry classifier for the builder.
sourcepub fn standard_retry(self, retry_config: &RetryConfig) -> Self
pub fn standard_retry(self, retry_config: &RetryConfig) -> Self
Configures the standard retry for the builder.
sourcepub fn timeout_config(self, timeout_config: TimeoutConfig) -> Self
pub fn timeout_config(self, timeout_config: TimeoutConfig) -> Self
Configures the timeout configuration for the builder.
sourcepub fn sleep_impl(self, async_sleep: impl AsyncSleep + 'static) -> Self
pub fn sleep_impl(self, async_sleep: impl AsyncSleep + 'static) -> Self
Configures the sleep for the builder.
sourcepub fn time_source(self, time_source: impl TimeSource + 'static) -> Self
pub fn time_source(self, time_source: impl TimeSource + 'static) -> Self
Configures the time source for the builder.
sourcepub fn interceptor(self, interceptor: impl Intercept + 'static) -> Self
pub fn interceptor(self, interceptor: impl Intercept + 'static) -> Self
Configures the interceptor for the builder.
sourcepub fn with_connection_poisoning(self) -> Self
pub fn with_connection_poisoning(self) -> Self
Registers the ConnectionPoisoningInterceptor
.
sourcepub fn runtime_plugin(
self,
runtime_plugin: impl RuntimePlugin + 'static,
) -> Self
pub fn runtime_plugin( self, runtime_plugin: impl RuntimePlugin + 'static, ) -> Self
Configures the runtime plugin for the builder.
sourcepub fn stalled_stream_protection(
self,
stalled_stream_protection: StalledStreamProtectionConfig,
) -> Self
pub fn stalled_stream_protection( self, stalled_stream_protection: StalledStreamProtectionConfig, ) -> Self
Configures stalled stream protection with the given config.
sourcepub fn serializer<I2>(
self,
serializer: impl Fn(I2) -> Result<HttpRequest, BoxError> + Send + Sync + 'static,
) -> OperationBuilder<I2, O, E>
pub fn serializer<I2>( self, serializer: impl Fn(I2) -> Result<HttpRequest, BoxError> + Send + Sync + 'static, ) -> OperationBuilder<I2, O, E>
Configures the serializer for the builder.
sourcepub fn deserializer<O2, E2>(
self,
deserializer: impl Fn(&HttpResponse) -> Result<O2, OrchestratorError<E2>> + Send + Sync + 'static,
) -> OperationBuilder<I, O2, E2>
pub fn deserializer<O2, E2>( self, deserializer: impl Fn(&HttpResponse) -> Result<O2, OrchestratorError<E2>> + Send + Sync + 'static, ) -> OperationBuilder<I, O2, E2>
Configures the deserializer for the builder.
sourcepub fn deserializer_impl<O2, E2>(
self,
deserializer: impl DeserializeResponse + Send + Sync + 'static,
) -> OperationBuilder<I, O2, E2>
pub fn deserializer_impl<O2, E2>( self, deserializer: impl DeserializeResponse + Send + Sync + 'static, ) -> OperationBuilder<I, O2, E2>
Configures the a deserializer implementation for the builder.
Trait Implementations§
Auto Trait Implementations§
impl<I, O, E> Freeze for OperationBuilder<I, O, E>
impl<I = (), O = (), E = ()> !RefUnwindSafe for OperationBuilder<I, O, E>
impl<I, O, E> Send for OperationBuilder<I, O, E>
impl<I, O, E> Sync for OperationBuilder<I, O, E>
impl<I, O, E> Unpin for OperationBuilder<I, O, E>
impl<I = (), O = (), E = ()> !UnwindSafe for OperationBuilder<I, O, E>
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> 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);