Struct Client

pub struct Client<C, B> { /* private fields */ }

A Client to make outgoing HTTP requests.

Client is cheap to clone and cloning is the recommended way to share a Client. The underlying connection pool will be reused.

Implementations

impl Client<(), ()>

pub fn builder<E>(executor: E) -> Builder

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

Create a builder to configure a new Client.

Example

use std::time::Duration;
use hyper_util::client::legacy::Client;
use hyper_util::rt::TokioExecutor;

let client = Client::builder(TokioExecutor::new())
    .pool_idle_timeout(Duration::from_secs(30))
    .http2_only(true)
    .build_http();

impl<C, B> Client<C, B>

where C: Connect + Clone + Send + Sync + 'static, B: Body + Send + 'static + Unpin, B::Data: Send, B::Error: Into<Box<dyn StdError + Send + Sync>>,

pub fn get(&self, uri: Uri) -> ResponseFuture

where B: Default,

Send a GET request to the supplied Uri.

Note

This requires that the Body type have a Default implementation. It should return an “empty” version of itself, such that Body::is_end_stream is true.

Example

use hyper::Uri;
use hyper_util::client::legacy::Client;
use hyper_util::rt::TokioExecutor;
use bytes::Bytes;
use http_body_util::Full;

let client: Client<_, Full<Bytes>> = Client::builder(TokioExecutor::new()).build_http();

let future = client.get(Uri::from_static("http://httpbin.org/ip"));

pub fn request(&self, req: Request<B>) -> ResponseFuture

Send a constructed Request using this Client.

Example

use hyper::{Method, Request};
use hyper_util::client::legacy::Client;
use http_body_util::Full;
use hyper_util::rt::TokioExecutor;
use bytes::Bytes;

let client: Client<_, Full<Bytes>> = Client::builder(TokioExecutor::new()).build_http();

let req: Request<Full<Bytes>> = Request::builder()
    .method(Method::POST)
    .uri("http://httpbin.org/post")
    .body(Full::from("Hallo!"))
    .expect("request builder");

let future = client.request(req);

Trait Implementations

impl<C: Clone, B> Clone for Client<C, B>

fn clone(&self) -> Client<C, B>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C, B> Debug for Client<C, B>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<C, B> Service<Request<B>> for &Client<C, B>

where C: Connect + Clone + Send + Sync + 'static, B: Body + Send + 'static + Unpin, B::Data: Send, B::Error: Into<Box<dyn StdError + Send + Sync>>,

type Response = Response<Incoming>

Responses given by the service.

type Error = Error

Errors produced by the service.

type Future = ResponseFuture

The future response value.

fn poll_ready(&mut self, _: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, req: Request<B>) -> Self::Future

Process the request and return the response asynchronously.

impl<C, B> Service<Request<B>> for Client<C, B>

where C: Connect + Clone + Send + Sync + 'static, B: Body + Send + 'static + Unpin, B::Data: Send, B::Error: Into<Box<dyn StdError + Send + Sync>>,

type Response = Response<Incoming>

Responses given by the service.

type Error = Error

Errors produced by the service.

type Future = ResponseFuture

The future response value.

fn poll_ready(&mut self, _: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, req: Request<B>) -> Self::Future

Process the request and return the response asynchronously.