Skip to main content

EasyHttpWebClient

rama::http::client

Struct EasyHttpWebClient 

Source 
pub struct EasyHttpWebClient<BodyIn, ConnResponse, L> { /* private fields */ }
Available on crate features dns and http-backend and http and std and tcp only.
Expand description

An opiniated http client that can be used to serve HTTP requests.

Use EasyHttpWebClient::connector_builder() to easily create a client with a common Http connector setup (tcp + proxy + tls + http) or bring your own http connector.

Default uses Rama’s default multiplexing connection pool. Build the connector explicitly with EasyHttpConnectorBuilder::without_connection_pool when connection reuse is unwanted.

You can fork this http client in case you have use cases not possible with this service example. E.g. perhaps you wish to have middleware in into outbound requests, after they passed through your “connector” setup. All this and more is possible by defining your own http client. Rama is here to empower you, the building blocks are there, go crazy with your own service fork and use the full power of Rust at your fingertips ;)

Implementations§

Source§

impl EasyHttpWebClient<(), (), ()>

Source

pub fn connector_builder() -> EasyHttpConnectorBuilder

Create a EasyHttpConnectorBuilder to easily create a EasyHttpWebClient with a custom connector

Source

pub fn try_blocking() -> Result<BlockingHttpWebClient>

Create a cloneable blocking HTTP(S) client with its own dedicated runtime thread and Rama’s default web connector stack.

use rama::http::client::EasyHttpWebClient;

let client = EasyHttpWebClient::try_blocking()?;
let client_for_worker = client.clone();

let text = client_for_worker
    .get("https://example.com/")
    .send()?
    .try_into_string()?;
Source§

impl<Body> EasyHttpWebClient<Body, EstablishedClientConnection<BindBodyToConn<MultiplexedConnection<HttpClientService<Body>, HttpConnId>>, Request<Body>>, ()>
where Body: StreamingBody<Data: Send + 'static, Error: Into<BoxError>> + Unpin + Send + 'static,

Source

pub fn default_with_executor(exec: Executor) -> Self

Source§

impl<BodyIn, ConnResponse> EasyHttpWebClient<BodyIn, ConnResponse, ()>
where BodyIn: Send + 'static,

Source

pub fn new<S>(connector: S) -> Self
where S: Service<Request<BodyIn>, Output = ConnResponse, Error: Into<BoxError>>,

Create a new EasyHttpWebClient using the provided connector.

Custom proxy connectors must honor PlaintextHttpProxyMode and publish EstablishedProxyRoute. Connection wrappers must preserve that metadata through ExtensionsRef.

Source§

impl<BodyIn, ConnResponse, L> EasyHttpWebClient<BodyIn, ConnResponse, L>

Source

pub fn try_into_blocking(self) -> Result<BlockingHttpClient<Self>>

Convert this asynchronous web client into a cloneable blocking client with its own dedicated runtime thread.

Source

pub fn into_blocking_with_runtime( self, runtime: &Runtime, ) -> BlockingHttpClient<Self>

Convert this asynchronous web client into a blocking client using a caller-supplied runtime.

Source

pub fn with_connector<S, BodyInNew, ConnResponseNew>( self, connector: S, ) -> EasyHttpWebClient<BodyInNew, ConnResponseNew, L>
where S: Service<Request<BodyInNew>, Output = ConnResponseNew, Error: Into<BoxError>>, BodyInNew: Send + 'static,

Set the connector that this EasyHttpWebClient will use.

Custom proxy connectors follow the metadata contract described in Self::new.

Source

pub fn with_jit_layer<T>( self, jit_layers: T, ) -> EasyHttpWebClient<BodyIn, ConnResponse, T>

Layer which will be applied just in time (JIT) before the request is sent, but after the connection has been established. Rama’s built-in forward-proxy policy is the innermost JIT service so it can act on the actual connection after caller middleware has processed the request, and can isolate a proxy challenge before caller middleware sees the response.

Simplified flow of how the EasyHttpWebClient works:

  1. External: let response = client.serve(request)
  2. Internal: let http_connection = self.connector.serve(request)
  3. Internal: wrap the connection in Rama’s forward-proxy policy
  4. Internal: let response = jit_layers.layer(http_connection).serve(request)
Source

pub fn with_forward_proxy_auth(self, enabled: bool) -> Self

Enable or disable automatic Basic or Bearer credentials on requests sent directly to an HTTP forward proxy.

This is enabled by default and acts only when the established connection is positively identified as an HTTP forward-proxy connection. It never adds credentials to direct, SOCKS, or HTTP CONNECT-tunneled requests.

Disabling this only disables insertion. Caller-provided Proxy-Authorization headers are preserved on established HTTP forward routes and always stripped on every other route, including connections without established route metadata.

Source

pub fn set_forward_proxy_auth(&mut self, enabled: bool) -> &mut Self

Enable or disable automatic Basic or Bearer credentials on requests sent directly to an HTTP forward proxy.

This is enabled by default and acts only when the established connection is positively identified as an HTTP forward-proxy connection. It never adds credentials to direct, SOCKS, or HTTP CONNECT-tunneled requests.

Disabling this only disables insertion. Caller-provided Proxy-Authorization headers are preserved on established HTTP forward routes and always stripped on every other route, including connections without established route metadata.

Source

pub fn without_forward_proxy_auth(self) -> Self

Disable automatic Basic or Bearer credentials on HTTP forward-proxy requests. The credential-stripping policy described by Self::with_forward_proxy_auth still applies.

Source

pub fn with_tunnel_plaintext_http(self, enabled: bool) -> Self

Enable or disable carrying plaintext HTTP through an HTTP(S) proxy with CONNECT instead of using ordinary forward-proxy semantics (absolute-form on HTTP/1).

If this method is not called, a request-level PlaintextHttpProxyMode is honored and otherwise forwarding is the connector default. Calling this method explicitly selects Tunnel (true) or Forward (false) for the client. Tunneling does not encrypt the origin traffic: a plaintext http:// request remains plaintext inside the proxy tunnel.

Source

pub fn set_tunnel_plaintext_http(&mut self, enabled: bool) -> &mut Self

Enable or disable carrying plaintext HTTP through an HTTP(S) proxy with CONNECT instead of using ordinary forward-proxy semantics (absolute-form on HTTP/1).

If this method is not called, a request-level PlaintextHttpProxyMode is honored and otherwise forwarding is the connector default. Calling this method explicitly selects Tunnel (true) or Forward (false) for the client. Tunneling does not encrypt the origin traffic: a plaintext http:// request remains plaintext inside the proxy tunnel.

Source

pub fn with_isolate_forward_proxy_auth_error(self, enabled: bool) -> Self

Enable or disable isolation of 407 Proxy Authentication Required responses received from an established HTTP forward proxy.

Ordinary clients expose such responses by default. Intermediaries should enable this option so an upstream proxy’s challenge, headers, and body cannot be forwarded to a different downstream proxy client.

Source

pub fn set_isolate_forward_proxy_auth_error( &mut self, enabled: bool, ) -> &mut Self

Enable or disable isolation of 407 Proxy Authentication Required responses received from an established HTTP forward proxy.

Ordinary clients expose such responses by default. Intermediaries should enable this option so an upstream proxy’s challenge, headers, and body cannot be forwarded to a different downstream proxy client.

Trait Implementations§

Source§

impl<BodyIn, ConnResponse, L: Clone> Clone for EasyHttpWebClient<BodyIn, ConnResponse, L>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<BodyIn, ConnResponse, L> Debug for EasyHttpWebClient<BodyIn, ConnResponse, L>

Source§

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

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

impl<Body, ConnectionBody, Connection, L> Service<Request<Body>> for EasyHttpWebClient<Body, EstablishedClientConnection<Connection, Request<ConnectionBody>>, L>
where Body: StreamingBody<Data: Send + 'static, Error: Into<BoxError>> + Unpin + Send + 'static, Connection: Service<Request<ConnectionBody>, Output = Response, Error = BoxError> + ExtensionsRef, ConnectionBody: StreamingBody<Data: Send + 'static, Error: Into<BoxError>> + Unpin + Send + 'static, L: Layer<HttpForwardProxyService<Connection>, Service: Service<Request<ConnectionBody>, Output = Response, Error = BoxError>> + Send + Sync + 'static,

Source§

type Output = Response

The type of the output returned by the service.
Source§

type Error = OpaqueError

The type of error returned by the service.
Source§

async fn serve(&self, req: Request<Body>) -> Result<Self::Output, Self::Error>

Serve an output or an error for the given input
§

fn boxed(self) -> BoxService<Input, Self::Output, Self::Error>

Box this service to allow for dynamic dispatch.

Auto Trait Implementations§

§

impl<BodyIn, ConnResponse, L> !RefUnwindSafe for EasyHttpWebClient<BodyIn, ConnResponse, L>

§

impl<BodyIn, ConnResponse, L> !UnwindSafe for EasyHttpWebClient<BodyIn, ConnResponse, L>

§

impl<BodyIn, ConnResponse, L> Freeze for EasyHttpWebClient<BodyIn, ConnResponse, L>
where BoxService<Request<BodyIn>, ConnResponse, OpaqueError>: Freeze, L: Freeze,

§

impl<BodyIn, ConnResponse, L> Send for EasyHttpWebClient<BodyIn, ConnResponse, L>
where BoxService<Request<BodyIn>, ConnResponse, OpaqueError>: Send, L: Send,

§

impl<BodyIn, ConnResponse, L> Sync for EasyHttpWebClient<BodyIn, ConnResponse, L>
where BoxService<Request<BodyIn>, ConnResponse, OpaqueError>: Sync, L: Sync,

§

impl<BodyIn, ConnResponse, L> Unpin for EasyHttpWebClient<BodyIn, ConnResponse, L>
where BoxService<Request<BodyIn>, ConnResponse, OpaqueError>: Unpin, L: Unpin,

§

impl<BodyIn, ConnResponse, L> UnsafeUnpin for EasyHttpWebClient<BodyIn, ConnResponse, L>
where BoxService<Request<BodyIn>, ConnResponse, OpaqueError>: UnsafeUnpin, L: UnsafeUnpin,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn from_ref(input: &T) -> T

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

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T, ReqBody, ResBody> GrpcService<ReqBody> for T
where T: Service<Request<ReqBody>, Output = Response<ResBody>>, <T as Service<Request<ReqBody>>>::Error: Into<Box<dyn Error + Send + Sync>>, ResBody: Body, <ResBody as Body>::Error: Into<Box<dyn Error + Send + Sync>>,

§

type ResponseBody = ResBody

Responses body given by the service.
§

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

Errors produced by the service.
§

fn serve( &self, request: Request<ReqBody>, ) -> impl Future<Output = Result<Response<<T as GrpcService<ReqBody>>::ResponseBody>, <T as GrpcService<ReqBody>>::Error>> + Send

Process the request and return the response asynchronously. Read more
§

impl<S, Body> HttpClientExt for S
where S: Service<Request, Output = Response<Body>>, <S as Service<Request>>::Error: Into<Box<dyn Error + Send + Sync>>,

§

type ExecuteResponse = Response<Body>

The response type returned by the execute method.
§

type ExecuteError = <S as Service<Request>>::Error

The error type returned by the execute method.
§

fn get( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a GET request to a URL. Read more
§

fn post( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a POST request to a URL. Read more
§

fn put( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a PUT request to a URL. Read more
§

fn patch( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a PATCH request to a URL. Read more
§

fn delete( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a DELETE request to a URL. Read more
§

fn head( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a HEAD request to a URL. Read more
§

fn connect( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a CONNECT request to a URL. Read more
§

fn request( &self, method: Method, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Start building a Request with the Method and Url. Read more
§

fn build_from_request<RequestBody>( &self, request: Request<RequestBody>, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>
where RequestBody: Into<Body>,

Start building a Request, using the given Request. Read more
§

fn execute( &self, request: Request, ) -> impl Future<Output = Result<<S as HttpClientExt>::ExecuteResponse, <S as HttpClientExt>::ExecuteError>>

Executes a Request. Read more
§

impl<S, Body> HttpClientWebSocketExt<Body> for S
where S: Service<Request, Output = Response<Body>>, <S as Service<Request>>::Error: Into<Box<dyn Error + Send + Sync>>,

§

fn websocket( &self, url: impl IntoUrl, ) -> WebSocketRequestBuilder<WithService<'_, S, Body>>

Create a new WebSocketRequestBuilder] to be used to establish a WebSocket connection over http/1.1.
§

fn websocket_h2( &self, url: impl IntoUrl, ) -> WebSocketRequestBuilder<WithService<'_, S, Body>>

Create a new WebSocketRequestBuilder to be used to establish a WebSocket connection over h2.
§

fn websocket_with_request<RequestBody>( &self, req: Request<RequestBody>, ) -> WebSocketRequestBuilder<WithService<'_, S, Body>>
where RequestBody: Into<Body>,

Create a new WebSocketRequestBuilder starting from the given request. Read more
§

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
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<S> IntoEndpointService<(S,)> for S
where S: Service<Request>,

§

type Service = S

§

fn into_endpoint_service(self) -> <S as IntoEndpointService<(S,)>>::Service

convert the type into a rama_core::Service.
§

impl<S, State> IntoEndpointServiceWithState<(S,), State> for S
where S: Service<Request>,

§

type Service = S

§

fn into_endpoint_service_with_state( self, _state: State, ) -> <S as IntoEndpointServiceWithState<(S,), State>>::Service

convert the type into a rama_core::Service with state.
§

impl<T> IntoRequest<T> for T

§

fn into_request(self) -> Request<T>

Wrap the input message T in a rama_grpc::Request
§

impl<L> LayerExt<L> for L

§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + 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
§

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

§

fn rama_from(value: T) -> U

§

impl<T, U, CrateMarker> RamaInto<U, CrateMarker> for T
where U: RamaFrom<T, CrateMarker>,

§

fn rama_into(self) -> U

§

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

§

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

§

fn rama_try_from(value: T) -> Result<U, <U as RamaTryFrom<T>>::Error>

§

impl<T, U, CrateMarker> RamaTryInto<U, CrateMarker> for T
where U: RamaTryFrom<T, CrateMarker>,

§

type Error = <U as RamaTryFrom<T, CrateMarker>>::Error

§

fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T, CrateMarker>>::Error>

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<V, F> ValueFormatter<&V> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

§

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.
The shape of values produced by this formatter. Read more
§

fn format_value(writer: impl ValueWriter, value: &&V)

Write value to writer
§

impl<V, F> ValueFormatter<Arc<V>> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

§

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.
The shape of values produced by this formatter. Read more
§

fn format_value(writer: impl ValueWriter, value: &Arc<V>)

Write value to writer
§

impl<V, F> ValueFormatter<Box<V>> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

§

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.
The shape of values produced by this formatter. Read more
§

fn format_value(writer: impl ValueWriter, value: &Box<V>)

Write value to writer
§

impl<V, F> ValueFormatter<Cow<'_, V>> for F
where V: ToOwned + ?Sized, F: ValueFormatter<V> + ?Sized,

§

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.
The shape of values produced by this formatter. Read more
§

fn format_value(writer: impl ValueWriter, value: &Cow<'_, V>)

Write value to writer
§

impl<V, F> ValueFormatter<Option<V>> for F
where F: ValueFormatter<V> + ?Sized,

§

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.
The shape of values produced by this formatter. Read more
§

fn format_value(writer: impl ValueWriter, value: &Option<V>)

Write value to writer
§

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