pub struct HyperClientBuilder { /* private fields */ }
Expand description

Builder for a hyper-backed HttpClient implementation.

This builder can be used to customize the underlying TCP connector used, as well as hyper client configuration.

§Examples

Construct a Hyper client with the default TLS implementation (rustls). This can be useful when you want to share a Hyper connector between multiple generated Smithy clients.

use aws_smithy_runtime::client::http::hyper_014::HyperClientBuilder;

let http_client = HyperClientBuilder::new().build_https();

// This connector can then be given to a generated service Config
let config = my_service_client::Config::builder()
    .endpoint_url("http://localhost:1234")
    .http_client(http_client)
    .build();
let client = my_service_client::Client::from_conf(config);

§Use a Hyper client with WebPKI roots

A use case for where you may want to use the HyperClientBuilder is when setting Hyper client settings that aren’t otherwise exposed by the Config builder interface. Some examples include changing:

  • Hyper client settings
  • Allowed TLS cipher suites
  • Using an alternative TLS connector library (not the default, rustls)
  • CA trust root certificates (illustrated using WebPKI below)
use aws_smithy_runtime::client::http::hyper_014::HyperClientBuilder;

let https_connector = hyper_rustls::HttpsConnectorBuilder::new()
    .with_webpki_roots()
    .https_only()
    .enable_http1()
    .enable_http2()
    .build();
let http_client = HyperClientBuilder::new().build(https_connector);

// This connector can then be given to a generated service Config
let config = my_service_client::Config::builder()
    .endpoint_url("https://example.com")
    .http_client(http_client)
    .build();
let client = my_service_client::Client::from_conf(config);

Implementations§

source§

impl HyperClientBuilder

source

pub fn new() -> Self

Creates a new builder.

source

pub fn hyper_builder(self, hyper_builder: Builder) -> Self

Override the Hyper client Builder used to construct this client.

This enables changing settings like forcing HTTP2 and modifying other default client behavior.

source

pub fn set_hyper_builder(&mut self, hyper_builder: Option<Builder>) -> &mut Self

Override the Hyper client Builder used to construct this client.

This enables changing settings like forcing HTTP2 and modifying other default client behavior.

source

pub fn build<C>(self, tcp_connector: C) -> SharedHttpClient
where C: Clone + Send + Sync + 'static + Service<Uri>, C::Response: Connection + AsyncRead + AsyncWrite + Send + Unpin + 'static, C::Future: Unpin + Send + 'static, C::Error: Into<BoxError>,

Create a SharedHttpClient from this builder and a given connector.

Trait Implementations§

source§

impl Clone for HyperClientBuilder

source§

fn clone(&self) -> HyperClientBuilder

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 Debug for HyperClientBuilder

source§

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

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

impl Default for HyperClientBuilder

source§

fn default() -> HyperClientBuilder

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

Auto Trait Implementations§

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
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> 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<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
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<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

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