Struct hyperdriver::client::ClientService

source · 
pub struct ClientService<T, P, BOut = Body>
where
    T: Transport,
    P: Protocol<T::IO>,
    P::Connection: PoolableConnection,
{ /* private fields */ }
Available on crate feature client only.
Expand description

A client which provides a simple HTTP tower::Service.

Client Services combine a transport (e.g. TCP) and a protocol (e.g. HTTP) to provide a tower::Service that can be used to make requests to a server. Optionally, a connection pool can be configured so that individual connections can be reused.

To use a client service, you must first poll the service to readiness with Service::poll_ready, and then make the request with Service::call. This can be simplified with the tower::ServiceExt which provides a Service::oneshot method that combines these two steps into a single future.

Implementations§

source§

impl<P, T, BOut> ClientService<T, P, BOut>
where T: Transport, P: Protocol<T::IO>, P::Connection: PoolableConnection,

source

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

Create a new client with the given transport, protocol, and pool configuration.

source

pub fn without_pool(self) -> Self

Disable connection pooling for this client.

source§

impl ClientService<TlsTransport<TcpTransport>, HttpConnectionBuilder, Body>

source

pub fn new_tcp_http() -> Self

Create a new client with the default configuration for making requests over TCP connections using the HTTP protocol.

When the tls feature is enabled, this will also add support for tls when using the https scheme, with a default TLS configuration that will rely on the system’s certificate store.

source§

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

source

pub fn request(&self, request: Request) -> Oneshot<Self, Request<Body>>

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

Trait Implementations§

source§

impl<P, T, B> Clone for ClientService<T, P, B>
where P: Protocol<T::IO> + Clone, P::Connection: PoolableConnection, T: Transport + Clone,

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<T, P, BOut: Debug> Debug for ClientService<T, P, BOut>
where T: Transport + Debug, P: Protocol<T::IO> + Debug, P::Connection: PoolableConnection + Debug,

source§

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

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

impl<P, C, T, BIn, BOut> Service<Request<BIn>> for ClientService<T, P, 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, C::ResBody: Into<Body>,

§

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, request: Request<BIn>) -> Self::Future

Process the request and return the response asynchronously. Read more

Auto Trait Implementations§

§

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

§

impl<T, P, BOut> RefUnwindSafe for ClientService<T, P, BOut>
where <P as Protocol<<T as Transport>::IO>>::Connection: Sized, T: RefUnwindSafe, P: RefUnwindSafe,

§

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

§

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

§

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

§

impl<T, P, BOut> UnwindSafe for ClientService<T, P, BOut>
where <P as Protocol<<T as Transport>::IO>>::Connection: Sized, T: UnwindSafe, P: 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<T> PolicyExt for T
where T: ?Sized,

source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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>

Available on crate feature tokio only.
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,