pub struct ChannelBuilder<O = ()> { /* private fields */ }Expand description
Builder for configuring a Channel.
Implementations§
Source§impl ChannelBuilder<()>
impl ChannelBuilder<()>
Sourcepub fn from_uri(uri: Uri) -> Self
pub fn from_uri(uri: Uri) -> Self
Create a ChannelBuilder using the given Uri
Source§impl<O> ChannelBuilder<O>where
O: IntoService<Channel>,
impl<O> ChannelBuilder<O>where
O: IntoService<Channel>,
Sourcepub fn with_timeout(self, timeout: Duration) -> Self
pub fn with_timeout(self, timeout: Duration) -> Self
Wrap the channel with a timeout.
Sourcepub fn with_refresh_layer<T>(
self,
layer: RefreshLayer<T>,
) -> ChannelBuilder<RefreshOptions<O, T>>
pub fn with_refresh_layer<T>( self, layer: RefreshLayer<T>, ) -> ChannelBuilder<RefreshOptions<O, T>>
Wrap the channel with the given RefreshLayer.
Sourcepub fn with_token_refresher<T>(
self,
refresher: T,
) -> ChannelBuilder<RefreshOptions<O, T>>
pub fn with_token_refresher<T>( self, refresher: T, ) -> ChannelBuilder<RefreshOptions<O, T>>
Wrap the channel with QCS authentication using the given TokenRefresher.
Sourcepub fn with_qcs_config(
self,
config: ClientConfiguration,
) -> ChannelBuilder<RefreshOptions<O, ClientConfiguration>>
pub fn with_qcs_config( self, config: ClientConfiguration, ) -> ChannelBuilder<RefreshOptions<O, ClientConfiguration>>
Wrap the channel with QCS authentication for the given ClientConfiguration.
Sourcepub fn with_qcs_profile(
self,
profile: Option<String>,
) -> Result<ChannelBuilder<RefreshOptions<O, ClientConfiguration>>, LoadError>
pub fn with_qcs_profile( self, profile: Option<String>, ) -> Result<ChannelBuilder<RefreshOptions<O, ClientConfiguration>>, LoadError>
Sourcepub fn with_retry_layer(
self,
layer: RetryLayer,
) -> ChannelBuilder<RetryOptions<O>>
pub fn with_retry_layer( self, layer: RetryLayer, ) -> ChannelBuilder<RetryOptions<O>>
Wrap the channel with the given RetryLayer.
Sourcepub fn with_retry_backoff(
self,
backoff: ExponentialBackoff,
) -> ChannelBuilder<RetryOptions<O>>
pub fn with_retry_backoff( self, backoff: ExponentialBackoff, ) -> ChannelBuilder<RetryOptions<O>>
Wrap the channel with the given ExponentialBackoff configuration.
Sourcepub fn with_default_retry(self) -> ChannelBuilder<RetryOptions<O>>
pub fn with_default_retry(self) -> ChannelBuilder<RetryOptions<O>>
Wrap the channel with the default retry logic. See default_backoff.
Sourcepub fn build(self) -> Result<O::Service, ChannelError>
pub fn build(self) -> Result<O::Service, ChannelError>
Trait Implementations§
Source§impl<O: Clone> Clone for ChannelBuilder<O>
impl<O: Clone> Clone for ChannelBuilder<O>
Source§fn clone(&self) -> ChannelBuilder<O>
fn clone(&self) -> ChannelBuilder<O>
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl<O: Debug> Debug for ChannelBuilder<O>
impl<O: Debug> Debug for ChannelBuilder<O>
Auto Trait Implementations§
impl<O = ()> !Freeze for ChannelBuilder<O>
impl<O = ()> !RefUnwindSafe for ChannelBuilder<O>
impl<O> Send for ChannelBuilder<O>where
O: Send,
impl<O> Sync for ChannelBuilder<O>where
O: Sync,
impl<O> Unpin for ChannelBuilder<O>where
O: Unpin,
impl<O = ()> !UnwindSafe for ChannelBuilder<O>
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§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> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T in a tonic::RequestSource§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>
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>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
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>
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>
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>
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>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
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 rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
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);