pub struct Client<C, B> { /* 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§
source§impl Client<(), ()>
impl Client<(), ()>
sourcepub fn builder<E>(executor: E) -> Builder
pub fn builder<E>(executor: E) -> Builder
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();
source§impl<C, B> Client<C, B>
impl<C, B> Client<C, B>
sourcepub fn get(&self, uri: Uri) -> ResponseFuturewhere
B: Default,
pub fn get(&self, uri: Uri) -> ResponseFuturewhere
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"));
sourcepub fn request(&self, req: Request<B>) -> ResponseFuture
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§
source§impl<C, B> Service<Request<B>> for &Client<C, B>
impl<C, B> Service<Request<B>> for &Client<C, B>
source§impl<C, B> Service<Request<B>> for Client<C, B>
impl<C, B> Service<Request<B>> for Client<C, B>
Auto Trait Implementations§
impl<C, B> Freeze for Client<C, B>where
C: Freeze,
impl<C, B> !RefUnwindSafe for Client<C, B>
impl<C, B> Send for Client<C, B>
impl<C, B> Sync for Client<C, B>
impl<C, B> Unpin for Client<C, B>where
C: Unpin,
impl<C, B> !UnwindSafe for Client<C, B>
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
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)source§impl<T> FutureExt for T
impl<T> FutureExt for T
source§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
source§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
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> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
source§impl<S, B> ServiceExt<B> for S
impl<S, B> ServiceExt<B> for S
fn request_bytes_to_body(self) -> BytesToBodyRequest<Self>
source§fn response_body_to_bytes(self) -> BodyToBytesResponse<Self>
fn response_body_to_bytes(self) -> BodyToBytesResponse<Self>
Adds a layer which collects all the response body into a contiguous
byte buffer.
This makes the response type
Response<Bytes>
.fn json_response<T>(self) -> JsonResponse<Self, T>
fn json_request<T>(self) -> JsonRequest<Self, T>
fn form_urlencoded_request<T>(self) -> FormUrlencodedRequest<Self, T>
source§fn catch_http_code<M, ResBody, E>(
self,
status_code: StatusCode,
mapper: M,
) -> CatchHttpCodes<Self, M>
fn catch_http_code<M, ResBody, E>( self, status_code: StatusCode, mapper: M, ) -> CatchHttpCodes<Self, M>
Catches responses with the given status code and then maps those
responses to an error type using the provided
mapper
function.source§fn catch_http_codes<B, M, ResBody, E>(
self,
bounds: B,
mapper: M,
) -> CatchHttpCodes<Self, M>
fn catch_http_codes<B, M, ResBody, E>( self, bounds: B, mapper: M, ) -> CatchHttpCodes<Self, M>
Catches responses with the given status codes and then maps those
responses to an error type using the provided
mapper
function.source§fn catch_http_errors<M, ResBody, E>(self, mapper: M) -> CatchHttpCodes<Self, M>
fn catch_http_errors<M, ResBody, E>(self, mapper: M) -> CatchHttpCodes<Self, M>
Shorthand for
Self::catch_http_codes
which catches all client errors
(4xx) and server errors (5xx).source§impl<T, Request> ServiceExt<Request> for T
impl<T, Request> ServiceExt<Request> for T
source§fn ready(&mut self) -> Ready<'_, Self, Request>where
Self: Sized,
fn ready(&mut self) -> Ready<'_, Self, Request>where
Self: Sized,
Yields a mutable reference to the service when it is ready to accept a request.
source§fn ready_and(&mut self) -> Ready<'_, Self, Request>where
Self: Sized,
fn ready_and(&mut self) -> Ready<'_, Self, Request>where
Self: Sized,
👎Deprecated since 0.4.6: please use the
ServiceExt::ready
method insteadYields a mutable reference to the service when it is ready to accept a request.
source§fn ready_oneshot(self) -> ReadyOneshot<Self, Request>where
Self: Sized,
fn ready_oneshot(self) -> ReadyOneshot<Self, Request>where
Self: Sized,
Yields the service when it is ready to accept a request.
source§fn oneshot(self, req: Request) -> Oneshot<Self, Request>where
Self: Sized,
fn oneshot(self, req: Request) -> Oneshot<Self, Request>where
Self: Sized,
Consume this
Service
, calling with the providing request once it is ready.source§fn and_then<F>(self, f: F) -> AndThen<Self, F>
fn and_then<F>(self, f: F) -> AndThen<Self, F>
Executes a new future after this service’s future resolves. This does
not alter the behaviour of the
poll_ready
method. Read moresource§fn map_response<F, Response>(self, f: F) -> MapResponse<Self, F>
fn map_response<F, Response>(self, f: F) -> MapResponse<Self, F>
Maps this service’s response value to a different value. This does not
alter the behaviour of the
poll_ready
method. Read moresource§fn map_err<F, Error>(self, f: F) -> MapErr<Self, F>
fn map_err<F, Error>(self, f: F) -> MapErr<Self, F>
Maps this service’s error value to a different value. This does not
alter the behaviour of the
poll_ready
method. Read moresource§fn map_result<F, Response, Error>(self, f: F) -> MapResult<Self, F>
fn map_result<F, Response, Error>(self, f: F) -> MapResult<Self, F>
Maps this service’s result type (
Result<Self::Response, Self::Error>
)
to a different value, regardless of whether the future succeeds or
fails. Read moresource§fn map_request<F, NewRequest>(self, f: F) -> MapRequest<Self, F>
fn map_request<F, NewRequest>(self, f: F) -> MapRequest<Self, F>
Composes a function in front of the service. Read more
source§fn then<F, Response, Error, Fut>(self, f: F) -> Then<Self, F>
fn then<F, Response, Error, Fut>(self, f: F) -> Then<Self, F>
Composes an asynchronous function after this service. Read more
source§fn map_future<F, Fut, Response, Error>(self, f: F) -> MapFuture<Self, F>
fn map_future<F, Fut, Response, Error>(self, f: F) -> MapFuture<Self, F>
Composes a function that transforms futures produced by the service. Read more