Struct hyperdriver::client::Client

source ·
pub struct Client<P = HttpConnectionBuilder, T = TlsTransport<TcpTransport>, B = Body>{ /* private fields */ }
Expand description

A simple async HTTP client.

This client is built on top of the tokio runtime and the hyper HTTP library. It combines a connection pool with a transport layer to provide a simple API for sending HTTP requests.

§Example

let client = Client::new_tcp_http();
let response = client.get("http://example.com".parse().unwrap()).await.unwrap();
println!("Response: {:?}", response);

Implementations§

source§

impl<P, T, B> Client<P, T, B>

source

pub fn new(connector: P, transport: T, pool: Config) -> Self

Create a new client with the given connector and pool configuration.

source§

impl Client<HttpConnectionBuilder, TlsTransport<TcpTransport>>

source

pub fn builder() -> Builder

A client builder for configuring the client.

source

pub fn new_tcp_http() -> Self

Create a new client with the default configuration.

source§

impl<P, C, T, B> Client<P, T, B>
where C: Connection + PoolableConnection, P: Protocol<T::IO, Connection = C, Error = ConnectionError> + Clone + Send + Sync + 'static, T: Transport + 'static, T::IO: Unpin, B: From<Body> + Unpin, <<T as Transport>::IO as HasConnectionInfo>::Addr: Send,

source

pub fn request( &self, request: Request, ) -> ResponseFuture<P::Connection, TransportStream<T::IO>, B>

Send an http Request, and return a Future of the Response.

source

pub async fn get(&self, uri: Uri) -> Result<Response<B>, Error>

Make a GET request to the given URI.

Trait Implementations§

source§

impl<P, T, B> Clone for Client<P, T, B>

source§

fn clone(&self) -> Self

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
source§

impl<P, T, B> Debug for Client<P, T, B>

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Client<HttpConnectionBuilder>

source§

fn default() -> Self

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

impl<P, C, T, BIn, BOut> Service<Request<BIn>> for Client<P, T, BOut>
where C: Connection + PoolableConnection, P: Protocol<T::IO, Connection = C, Error = ConnectionError> + Clone + Send + Sync + 'static, T: Transport + 'static, T::IO: Unpin, BIn: Into<Body>, BOut: From<Body> + Unpin, <<T as Transport>::IO as HasConnectionInfo>::Addr: Send,

§

type Response = Response<BOut>

Responses given by the service.
§

type Error = Error

Errors produced by the service.
§

type Future = ResponseFuture<<P as Protocol<<T as Transport>::IO>>::Connection, TransportStream<<T as Transport>::IO>, BOut>

The future response value.
source§

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
source§

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

Process the request and return the response asynchronously. Read more

Auto Trait Implementations§

§

impl<P, T, B> Freeze for Client<P, T, B>
where <P as Protocol<<T as Transport>::IO>>::Connection: Sized, P: Freeze, T: Freeze,

§

impl<P, T, B> RefUnwindSafe for Client<P, T, B>

§

impl<P, T, B> Send for Client<P, T, B>
where <P as Protocol<<T as Transport>::IO>>::Connection: Sized, P: Send,

§

impl<P, T, B> Sync for Client<P, T, B>
where <P as Protocol<<T as Transport>::IO>>::Connection: Sized, P: Sync, T: Sync,

§

impl<P, T, B> Unpin for Client<P, T, B>
where <P as Protocol<<T as Transport>::IO>>::Connection: Sized, P: Unpin, T: Unpin,

§

impl<P, T, B> UnwindSafe for Client<P, T, B>
where <P as Protocol<<T as Transport>::IO>>::Connection: Sized, P: UnwindSafe, T: UnwindSafe,

Blanket Implementations§

source§

impl<BIn, BOut, S> AdaptCustomBodyExt<BIn, BOut> for S
where S: Service<Request<BIn>, Response = Response<BOut>>,

source§

fn adapt_custom_body(self) -> AdaptCustomBodyService<BIn, BOut, S>

Adapt a service to use custom body types internally, but still accept and return Body as the outer body type.
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> CloneToUninit for T
where T: Clone,

source§

default 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
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
source§

impl<T, B1, B2> HttpService<B1> for T
where T: Service<Request<B1>, Response = Response<B2>>, B2: Body, <T as Service<Request<B1>>>::Error: Into<Box<dyn Error + Sync + Send>>,

§

type ResBody = B2

The HttpBody body of the http::Response.
§

type Error = <T as Service<Request<B1>>>::Error

The error type that can occur within this Service. Read more
§

type Future = <T as Service<Request<B1>>>::Future

The Future returned by this Service.
source§

fn poll_ready( &mut self, cx: &mut Context<'_>, ) -> Poll<Result<(), <T as HttpService<B1>>::Error>>

source§

fn call(&mut self, req: Request<B1>) -> <T as HttpService<B1>>::Future

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<S, R> ServiceExt<R> for S
where S: Service<R>,

source§

fn into_make_service(self) -> IntoMakeService<S>

Convert this service into a MakeService, that is a Service whose response is another service. Read more
source§

fn into_make_service_with_connect_info<C>( self, ) -> IntoMakeServiceWithConnectInfo<S, C>

Convert this service into a MakeService, that will store C’s associated ConnectInfo in a request extension such that ConnectInfo can extract it. Read more
source§

fn handle_error<F, T>(self, f: F) -> HandleError<Self, F, T>

Convert this service into a HandleError, that will handle errors by converting them into responses. Read more
source§

impl<T, Request> ServiceExt<Request> for T
where T: Service<Request> + ?Sized,

source§

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,

👎Deprecated since 0.4.6: please use the ServiceExt::ready method instead
Yields 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,

Yields the service when it is ready to accept a request.
source§

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 call_all<S>(self, reqs: S) -> CallAll<Self, S>
where Self: Sized, Self::Error: Into<Box<dyn Error + Sync + Send>>, S: Stream<Item = Request>,

Process all requests from the given Stream, and produce a Stream of their responses. Read more
source§

fn and_then<F>(self, f: F) -> AndThen<Self, F>
where Self: Sized, F: Clone,

Executes a new future after this service’s future resolves. This does not alter the behaviour of the poll_ready method. Read more
source§

fn map_response<F, Response>(self, f: F) -> MapResponse<Self, F>
where Self: Sized, F: FnOnce(Self::Response) -> Response + Clone,

Maps this service’s response value to a different value. This does not alter the behaviour of the poll_ready method. Read more
source§

fn map_err<F, Error>(self, f: F) -> MapErr<Self, F>
where Self: Sized, F: FnOnce(Self::Error) -> Error + Clone,

Maps this service’s error value to a different value. This does not alter the behaviour of the poll_ready method. Read more
source§

fn map_result<F, Response, Error>(self, f: F) -> MapResult<Self, F>
where Self: Sized, Error: From<Self::Error>, F: FnOnce(Result<Self::Response, Self::Error>) -> Result<Response, Error> + Clone,

Maps this service’s result type (Result<Self::Response, Self::Error>) to a different value, regardless of whether the future succeeds or fails. Read more
source§

fn map_request<F, NewRequest>(self, f: F) -> MapRequest<Self, F>
where Self: Sized, F: FnMut(NewRequest) -> Request,

Composes a function in front of the service. Read more
source§

fn then<F, Response, Error, Fut>(self, f: F) -> Then<Self, F>
where Self: Sized, Error: From<Self::Error>, F: FnOnce(Result<Self::Response, Self::Error>) -> Fut + Clone, Fut: Future<Output = Result<Response, Error>>,

Composes an asynchronous function after this service. Read more
source§

fn map_future<F, Fut, Response, Error>(self, f: F) -> MapFuture<Self, F>
where Self: Sized, F: FnMut(Self::Future) -> Fut, Error: From<Self::Error>, Fut: Future<Output = Result<Response, Error>>,

Composes a function that transforms futures produced by the service. Read more
source§

fn boxed(self) -> BoxService<Request, Self::Response, Self::Error>
where Self: Sized + Send + 'static, Self::Future: Send + 'static,

Convert the service into a Service + Send trait object. Read more
source§

fn boxed_clone(self) -> BoxCloneService<Request, Self::Response, Self::Error>
where Self: Sized + Clone + Send + 'static, Self::Future: Send + 'static,

Convert the service into a Service + Clone + Send trait object. Read more
source§

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

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

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

§

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

§

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<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
source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,