Struct ClientBuilder 

pub struct ClientBuilder<Svc> { /* private fields */ }

Builder for Client instances with customized tower middleware.

Implementations

impl<Svc> ClientBuilder<Svc>

pub fn new(service: Svc, default_namespace: impl Into<String>) -> Self

where Svc: Service<Request<Body>>,

Construct a ClientBuilder from scratch with a fully custom Service stack.

This method is only intended for advanced use cases, most users will want to use ClientBuilder::try_from instead, which provides a default stack as a starting point.

pub fn with_layer<L: Layer<Svc>>(self, layer: &L) -> ClientBuilder<L::Service>

Add a Layer to the current Service stack.

pub fn with_valid_until(self, valid_until: Option<Timestamp>) -> Self

Sets an expiration timestamp for the client.

pub fn build<B>(self) -> Client

where Svc: Service<Request<Body>, Response = Response<B>> + Send + 'static, Svc::Future: Send + 'static, Svc::Error: Into<BoxError>, B: Body<Data = Bytes> + Send + 'static, B::Error: Into<BoxError>,

Build a Client instance with the current Service stack.

Trait Implementations

impl<E> TryFrom<(Config, E)> for ClientBuilder<BoxService<Request<Body>, Response<Box<DynBody>>, BoxError>>

where E: Executor<Pin<Box<dyn Future<Output = ()> + Send>>> + Send + Sync + Clone + 'static,

fn try_from((config, executor): (Config, E)) -> Result<Self>

Builds a default ClientBuilder stack from a given configuration.

Examples

Install a tracing executor that propagates tracing spans to spawned tasks.

use hyper_util::rt::{CurrentSpanExecutor, TokioExecutor};
use kube_client::{client::ClientBuilder, config::Config};

#[tokio::main]
async fn main() {
    let config = Config::infer().await.unwrap();
    let executor = CurrentSpanExecutor::new(TokioExecutor::new());
    let builder = ClientBuilder::try_from((config, executor)).unwrap();
    let client = builder.build();
}

type Error = Error

The type returned in the event of a conversion error.

impl TryFrom<Config> for ClientBuilder<BoxService<Request<Body>, Response<Box<DynBody>>, BoxError>>

fn try_from(config: Config) -> Result<Self>

Builds a default ClientBuilder stack from a given configuration.

By default, the client builder builds an HTTP client that relies on a TokioExecutor to spawn background tasks. To install an executor that propagates tracing spans, use <ClientBuilder<Svc> as TryFrom<(Config, E)>>::try_from().

Examples

use kube_client::{client::ClientBuilder, config::Config};

#[tokio::main]
async fn main() {
    let config = Config::infer().await.unwrap();
    let builder = ClientBuilder::try_from(config).unwrap();
    let client = builder.build();
}

type Error = Error

The type returned in the event of a conversion error.