Struct quinn::generic::ClientConfigBuilder

pub struct ClientConfigBuilder<S> where
    S: Session,  { /* fields omitted */ }

Helper for creating new outgoing connections.

If the native-certs and ct-logs features are enabled, ClientConfigBuilder::default() will construct a configuration that trusts the host OS certificate store and uses built-in certificate transparency logs respectively. These features are both enabled by default.

Implementations

impl<S> ClientConfigBuilder<S> where
    S: Session, 

pub fn new(config: ClientConfig<S>) -> Self

Construct a builder using config as the initial state.

If you want to trust the usual certificate authorities trusted by the system, use ClientConfigBuilder::default() with the native-certs and ct-logs features enabled instead.

The ClientConfigBuilder provides a number of shortcuts to customize the TLS client behavior. However, if you want to take full control over the client’s behavior (such as setting up TLS mutual authentication), you can use the associated new() function to provide a ClientConfig with TLS configuration provided directly through its crypto field).

pub fn build(self) -> ClientConfig<S>

Consume the builder and return the ClientConfig, which can then be used to configure outgoing connections from an Endpoint.

impl ClientConfigBuilder<TlsSession>

pub fn add_certificate_authority(
    &mut self,
    cert: Certificate
) -> Result<&mut Self, Error>

Add a trusted certificate authority.

For more advanced/less secure certificate verification, construct a ClientConfig manually and use rustls’s dangerous_configuration feature to override the certificate verifier.

pub fn enable_keylog(&mut self) -> &mut Self

Enable NSS-compatible cryptographic key logging to the SSLKEYLOGFILE environment variable.

Useful for debugging encrypted communications with protocol analyzers such as Wireshark.

pub fn protocols(&mut self, protocols: &[&[u8]]) -> &mut Self

Set the application-layer protocols to accept, in order of descending preference.

When set, clients which don’t declare support for at least one of the supplied protocols will be rejected.

The IANA maintains a registry of standard protocol IDs, but custom IDs may be used as well.

pub fn enable_0rtt(&mut self) -> &mut Self

Enable 0-RTT.

Trait Implementations

impl<S> Clone for ClientConfigBuilder<S> where
    S: Session, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> Default for ClientConfigBuilder<S> where
    S: Session, 

fn default() -> Self

Returns the “default value” for a type.