Struct mongod::ClientBuilder

pub struct ClientBuilder { /* fields omitted */ }

A ClientBuilder can be used to create a Client with custom configuration.

Implementations

impl ClientBuilder

pub fn new() -> Self

Constructs a new ClientBuilder.

This is the same as Client::Builder().

pub fn build(self) -> Result<Client, Error>

Returns a Client built from this ClientBuilder configuration.

Errors

This method fails if the mongodb::Client cannot be initialised.

pub fn auth<U, P>(self, username: U, password: Option<P>) -> Self where
    U: Display,
    P: Display, 

Sets the username/password that should be used by this client.

Example

    let _client = mongod::Client::builder()
        .auth("foo", Some("bar"))
        .build().unwrap();

pub fn ca<I: Into<String>>(self, path: I) -> Self

Sets the CA file that should be used by this client for TLS.

Example

    let _client = mongod::Client::builder()
        .ca("./certs/foo.pem")
        .build().unwrap();

pub fn cert_key<I: Into<String>>(self, path: I) -> Self

Sets the certificate file that should be used by this client for identification.

Example

    let _client = mongod::Client::builder()
        .cert_key("./certs/foo.pem")
        .build().unwrap();

pub fn database<I: Into<String>>(self, database: I) -> Self

Sets the database that should be used by this client.

Example

    let _client = mongod::Client::builder()
        .database("foo")
        .build().unwrap();

pub fn uri<I: Into<String>>(self, uri: I) -> Self

Sets the uri that this client should use to connect to a mongo instance.

Example

    let _client = mongod::Client::builder()
        .uri("mongodb://foo")
        .build()?;

Trait Implementations

impl Default for ClientBuilder

fn default() -> Self

Returns the “default value” for a type.