Struct hyper_rustls::HttpsConnectorBuilder

pub struct HttpsConnectorBuilder<State>(/* private fields */);

A builder for an HttpsConnector

This makes configuration flexible and explicit and ensures connector features match crate features

Examples

use hyper_rustls::HttpsConnectorBuilder;

let https = HttpsConnectorBuilder::new()
    .with_webpki_roots()
    .https_only()
    .enable_http1()
    .build();

Implementations

impl ConnectorBuilder<WantsTlsConfig>

pub fn new() -> Self

Creates a new ConnectorBuilder

pub fn with_tls_config( self, config: ClientConfig ) -> ConnectorBuilder<WantsSchemes>

Passes a rustls ClientConfig to configure the TLS connection

The alpn_protocols field is required to be empty (or the function will panic) and will be rewritten to match the enabled schemes (see enable_http1, enable_http2) before the connector is built.

pub fn with_native_roots(self) -> Result<ConnectorBuilder<WantsSchemes>>

Available on crate features ring and rustls-native-certs only.

Shorthand for using rustls’ default crypto provider and safe defaults, with native roots.

See ConfigBuilderExt::with_native_roots

pub fn with_provider_and_native_roots( self, provider: CryptoProvider ) -> Result<ConnectorBuilder<WantsSchemes>>

Available on crate feature rustls-native-certs only.

Shorthand for using a custom CryptoProvider and native roots

See ConfigBuilderExt::with_native_roots

pub fn with_webpki_roots(self) -> ConnectorBuilder<WantsSchemes>

Available on crate features ring and webpki-roots only.

Shorthand for using rustls’ default crypto provider and its safe defaults.

See ConfigBuilderExt::with_webpki_roots

pub fn with_provider_and_webpki_roots( self, provider: CryptoProvider ) -> Result<ConnectorBuilder<WantsSchemes>, Error>

Available on crate feature webpki-roots only.

Shorthand for using a custom CryptoProvider, Rustls’ safe default protocol versions and Mozilla roots

See ConfigBuilderExt::with_webpki_roots

impl ConnectorBuilder<WantsSchemes>

pub fn https_only(self) -> ConnectorBuilder<WantsProtocols1>

Enforce the use of HTTPS when connecting

Only URLs using the HTTPS scheme will be connectable.

pub fn https_or_http(self) -> ConnectorBuilder<WantsProtocols1>

Allow both HTTPS and HTTP when connecting

HTTPS URLs will be handled through rustls, HTTP URLs will be handled by the lower-level connector.

impl ConnectorBuilder<WantsProtocols1>

pub fn enable_http1(self) -> ConnectorBuilder<WantsProtocols2>

Available on crate feature http1 only.

Enable HTTP1

This needs to be called explicitly, no protocol is enabled by default

pub fn enable_http2(self) -> ConnectorBuilder<WantsProtocols3>

Available on crate feature http2 only.

Enable HTTP2

This needs to be called explicitly, no protocol is enabled by default

pub fn enable_all_versions(self) -> ConnectorBuilder<WantsProtocols3>

Available on crate feature http2 only.

Enable all HTTP versions built into this library (enabled with Cargo features)

For now, this could enable both HTTP 1 and 2, depending on active features. In the future, other supported versions will be enabled as well.

pub fn with_server_name(self, override_server_name: String) -> Self

Override server name for the TLS stack

By default, for each connection hyper-rustls will extract host portion of the destination URL and verify that server certificate contains this value.

If this method is called, hyper-rustls will instead verify that server certificate contains override_server_name. Domain name included in the URL will not affect certificate validation.

impl ConnectorBuilder<WantsProtocols2>

pub fn enable_http2(self) -> ConnectorBuilder<WantsProtocols3>

Available on crate feature http2 only.

Enable HTTP2

This needs to be called explicitly, no protocol is enabled by default

pub fn build(self) -> HttpsConnector<HttpConnector>

This builds an HttpsConnector built on hyper’s default HttpConnector

pub fn wrap_connector<H>(self, conn: H) -> HttpsConnector<H>

This wraps an arbitrary low-level connector into an HttpsConnector

impl ConnectorBuilder<WantsProtocols3>

pub fn build(self) -> HttpsConnector<HttpConnector>

Available on crate feature http2 only.

This builds an HttpsConnector built on hyper’s default HttpConnector

pub fn wrap_connector<H>(self, conn: H) -> HttpsConnector<H>

Available on crate feature http2 only.

This wraps an arbitrary low-level connector into an HttpsConnector

Trait Implementations

impl Default for ConnectorBuilder<WantsTlsConfig>

fn default() -> Self

Returns the “default value” for a type.