Struct mongodb::options::TlsOptions

#[non_exhaustive]
pub struct TlsOptions {
    pub allow_invalid_certificates: Option<bool>,
    pub ca_file_path: Option<PathBuf>,
    pub cert_key_file_path: Option<PathBuf>,
    pub allow_invalid_hostnames: Option<bool>,
}

Specifies the TLS configuration that the Client should use.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

allow_invalid_certificates: Option<bool>

Whether or not the Client should return an error if the server presents an invalid certificate. This setting should not be set to true in production; it should only be used for testing.

The default value is to error when the server presents an invalid certificate.

ca_file_path: Option<PathBuf>

The path to the CA file that the Client should use for TLS. If none is specified, then the driver will use the Mozilla root certificates from the webpki-roots crate.

cert_key_file_path: Option<PathBuf>

The path to the certificate file that the Client should present to the server to verify its identify. If none is specified, then the Client will not attempt to verify its identity to the server.

allow_invalid_hostnames: Option<bool>

Available on crate feature openssl-tls only.

Whether or not the Client should return an error if the hostname is invalid.

The default value is to error on invalid hostnames.

Implementations

impl TlsOptions

pub fn builder() -> TlsOptionsBuilder<((), (), (), ())>

Create a builder for building TlsOptions. On the builder, call .allow_invalid_certificates(...)(optional), .ca_file_path(...)(optional), .cert_key_file_path(...)(optional), .allow_invalid_hostnames(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of TlsOptions.

Trait Implementations

impl Clone for TlsOptions

fn clone(&self) -> TlsOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TlsOptions

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

Formats the value using the given formatter.

impl Default for TlsOptions

fn default() -> TlsOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TlsOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<TlsOptions> for Option<Tls>

fn from(options: TlsOptions) -> Self

Converts to this type from the input type.

impl From<TlsOptions> for Tls

fn from(options: TlsOptions) -> Self

Converts to this type from the input type.

impl PartialEq for TlsOptions

fn eq(&self, other: &TlsOptions) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TlsOptions