Skip to main content

ClientBuilder

Struct ClientBuilder 

Source
pub struct ClientBuilder { /* private fields */ }

Implementations§

Source§

impl ClientBuilder

Source

pub fn endpoints(endpoints: Vec<String>) -> Self

Source

pub fn batch_flush_interval(self, flush_interval: Duration) -> Self

Source

pub fn retry_policy(self, policy: RetryPolicy) -> Self

Override the default RetryPolicy.

The policy controls per-attempt deadlines, the overall deadline across all candidate endpoints, the cap on attempts, and the jittered backoff base. The per-attempt deadline is also pushed down to tonic::transport::Endpoint::connect_timeout and Endpoint::timeout for the built-in default and TLS transport paths so a blackholed peer fails fast at the transport layer. User-supplied Self::channel_connector closures own their own Endpoint config; the policy still bounds the retry loop’s outer tokio::time::timeout around them.

Source

pub fn tls_config(self, cfg: ClientTlsConfig) -> Self

Configure the client to dial bare endpoints with TLS. Bare host:port becomes https://host:port; explicit http://... endpoints supplied in Self::endpoints remain plaintext; explicit https://... endpoints use the provided TLS config.

Wire-supplied http://... leader-hint trailers are NOT honored under tls_config — they are dropped to prevent a contacted peer from downgrading the transport. Operator-supplied configuration still wins; untrusted wire input does not.

Setting both Self::channel_connector and tls_config is allowed; the last call wins (standard builder semantics). Calling channel_connector after tls_config also clears the reject-plaintext-hint policy, since the caller-owned connector owns its own scheme policy.

Source

pub fn channel_connector<F, Fut>(self, connector: F) -> Self
where F: Fn(&str) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Channel, BoxError>> + Send + 'static,

Replace the default plaintext channel construction with a caller-owned closure. The closure is invoked on first use of each endpoint — configured endpoints and leader-hint redirects alike. Errors returned from the closure surface as ClientError::Connector.

See module docs for the interaction with Self::tls_config (last-wins) and the scheme matrix. A caller-owned connector replaces the built-in TLS plumbing entirely, including the reject-plaintext-leader-hint policy — the closure is responsible for whatever scheme policy it wants to enforce.

Source

pub async fn build(self) -> Result<Client, ClientError>

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> 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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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