Struct ClientBuilder

pub struct ClientBuilder<T>(/* private fields */);

Available on rustls only.

Helper to construct an Endpoint for use with outgoing connections only.

To get one, call new_with_xxx methods.

Implementations

impl ClientBuilder<RootCertStore>

pub fn new_with_empty_roots() -> Self

Create a builder with an empty rustls::RootCertStore.

pub fn new_with_native_certs() -> Result<Self>

Available on crate feature native-certs only.

Create a builder with rustls_native_certs.

pub fn new_with_webpki_roots() -> Self

Available on crate feature webpki-roots only.

Create a builder with webpki_roots.

pub fn with_custom_certificate( self, der: CertificateDer<'_>, ) -> Result<Self, Error>

Add a custom certificate.

pub fn with_no_crls(self) -> ClientBuilder<ClientConfig>

Don’t configure revocation.

pub fn with_crls( self, crls: impl IntoIterator<Item = CertificateRevocationListDer<'static>>, ) -> Result<ClientBuilder<ClientConfig>, VerifierBuilderError>

Verify the revocation state of presented client certificates against the provided certificate revocation lists (CRLs).

impl ClientBuilder<ClientConfig>

pub fn new_with_rustls_client_config( client_config: ClientConfig, ) -> ClientBuilder<ClientConfig>

Create a builder with the provided rustls::ClientConfig.

pub fn new_with_no_server_verification() -> ClientBuilder<ClientConfig>

Do not verify the server’s certificate. It is vulnerable to MITM attacks, but convenient for testing.

pub fn new_with_platform_verifier() -> ClientBuilder<ClientConfig>

Available on crate feature platform-verifier only.

Create a builder with rustls_platform_verifier.

pub fn new_with_root_certificates( roots: RootCertStore, ) -> ClientBuilder<ClientConfig>

Create a builder with the provided rustls::RootCertStore.

pub fn new_with_webpki_verifier( verifier: Arc<WebPkiServerVerifier>, ) -> ClientBuilder<ClientConfig>

Create a builder with a custom rustls::client::WebPkiServerVerifier.

pub fn with_alpn_protocols(self, protocols: &[&str]) -> Self

Set the ALPN protocols to use.

pub fn with_key_log(self) -> Self

Logging key material to a file for debugging. The file’s name is given by the SSLKEYLOGFILE environment variable.

If SSLKEYLOGFILE is not set, or such a file cannot be opened or cannot be written, this does nothing.

pub fn build(self) -> ClientConfig

Build a ClientConfig.

pub async fn bind(self, addr: impl ToSocketAddrsAsync) -> Result<Endpoint>

Create a new Endpoint.

See Endpoint::client for more information.

Trait Implementations

impl<T: Debug> Debug for ClientBuilder<T>

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

Formats the value using the given formatter.