Struct HyperClientBuilder

pub struct HyperClientBuilder { /* private fields */ }

Available on crate features client and connector-hyper-0-14-x only.

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

impl HyperClientBuilder

pub fn new() -> Self

Creates a new builder.

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.

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.

pub fn build_https(self) -> SharedHttpClient

Available on crate feature tls-rustls only.

Create a hyper client with the default rustls HTTPS implementation.

The trusted certificates will be loaded later when this becomes the selected HTTP client for a Smithy client.

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.

Use build_https if you don’t want to provide a custom TCP connector.

Trait Implementations

impl Clone for HyperClientBuilder

fn clone(&self) -> HyperClientBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HyperClientBuilder

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

Formats the value using the given formatter.

impl Default for HyperClientBuilder

fn default() -> HyperClientBuilder

Returns the “default value” for a type.