Struct Client

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

Expand description

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<HttpConnector, Body>

pub fn new() -> Client<HttpConnector, Body>

Create a new Client with the default config.

§Note

The default connector does not handle TLS. Speaking to https destinations will require configuring a connector that implements TLS.

impl Client<(), Body>

pub fn builder() -> Builder

Create a builder to configure a new Client.

§Example

use std::time::Duration;
use hyper::Client;

let client = Client::builder()
    .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: HttpBody + Send + 'static, 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 HttpBody type have a Default implementation. It should return an “empty” version of itself, such that HttpBody::is_end_stream is true.

§Example

use hyper::{Client, Uri};

let client = Client::new();

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::{Body, Method, Client, Request};

let client = Client::new();

let req = Request::builder()
    .method(Method::POST)
    .uri("http://httpbin.org/post")
    .body(Body::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. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

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

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

Formats the value using the given formatter. Read more

impl Default for Client<HttpConnector, Body>

fn default() -> Client<HttpConnector, Body>

Returns the “default value” for a type. Read more

impl<C, B> Service<Request<B>> for &Client<C, B>
where C: Connect + Clone + Send + Sync + 'static, B: HttpBody + Send + 'static, B::Data: Send, B::Error: Into<Box<dyn StdError + Send + Sync>>,

type Response = Response<Body>

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. Read more

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

Process the request and return the response asynchronously. Read more

impl<C, B> Service<Request<B>> for Client<C, B>
where C: Connect + Clone + Send + Sync + 'static, B: HttpBody + Send + 'static, B::Data: Send, B::Error: Into<Box<dyn StdError + Send + Sync>>,

type Response = Response<Body>

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. Read more

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

Process the request and return the response asynchronously. Read more

Auto Trait Implementations§

impl<C, B> Freeze for Client<C, B>
where C: Freeze,

impl<C, B = Body> !RefUnwindSafe for Client<C, B>

impl<C, B> Send for Client<C, B>
where C: Send, B: Send,

impl<C, B> Sync for Client<C, B>
where C: Sync, B: Send,

impl<C, B> Unpin for Client<C, B>
where C: Unpin,

impl<C, B = Body> !UnwindSafe for Client<C, B>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more