Struct EncryptedClientBuilder

pub struct EncryptedClientBuilder { /* private fields */ }

Available on crate feature in-use-encryption only.

A builder for constructing a Client with auto-encryption enabled.

let encrypted_client = Client::encrypted_builder(
    client_options,
    key_vault_namespace,
    [(KmsProvider::Local, doc! { "key": local_key }, None)],
)?
.key_vault_client(key_vault_client)
.build()
.await?;

Implementations

impl EncryptedClientBuilder

pub fn key_vault_client(self, client: impl Into<Option<Client>>) -> Self

Set the client used for data key queries. Will default to an internal client if not set.

pub fn schema_map( self, map: impl IntoIterator<Item = (impl Into<String>, Document)>, ) -> Self

Specify a JSONSchema locally.

Supplying a schema_map provides more security than relying on JSON Schemas obtained from the server. It protects against a malicious server advertising a false JSON Schema, which could trick the client into sending unencrypted data that should be encrypted.

Schemas supplied in the schema_map only apply to configuring automatic encryption for client side encryption. Other validation rules in the JSON schema will not be enforced by the driver and will result in an error.

pub fn bypass_auto_encryption(self, bypass: impl Into<Option<bool>>) -> Self

Disable automatic encryption and do not spawn mongocryptd. Defaults to false.

pub fn extra_options(self, extra_opts: impl Into<Option<Document>>) -> Self

Set options related to mongocryptd.

pub fn encrypted_fields_map( self, map: impl IntoIterator<Item = (impl Into<String>, Document)>, ) -> Self

Maps namespace to encrypted fields.

Supplying an encrypted_fields_map provides more security than relying on an encryptedFields obtained from the server. It protects against a malicious server advertising a false encryptedFields.

pub fn bypass_query_analysis(self, bypass: impl Into<Option<bool>>) -> Self

Disable serverside processing of encrypted indexed fields, allowing use of explicit encryption with queryable encryption.

pub fn key_cache_expiration( self, expiration: impl Into<Option<Duration>>, ) -> Self

Set the duration of time after which the data encryption key cache should expire. Defaults to 60 seconds if unset.

pub async fn build(self) -> Result<Client>

Constructs a new Client using automatic encryption. May perform DNS lookups and/or spawn mongocryptd as part of Client initialization.