Struct mungos::options::Credential

#[non_exhaustive]
pub struct Credential {
    pub username: Option<String>,
    pub source: Option<String>,
    pub password: Option<String>,
    pub mechanism: Option<AuthMechanism>,
    pub mechanism_properties: Option<Document>,
}

A struct containing authentication information.

Some fields (mechanism and source) may be omitted and will either be negotiated or assigned a default value, depending on the values of other fields in the credential.

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.

username: Option<String>

The username to authenticate with. This applies to all mechanisms but may be omitted when authenticating via MONGODB-X509.

source: Option<String>

The database used to authenticate. This applies to all mechanisms and defaults to “admin” in SCRAM authentication mechanisms, “$external” for GSSAPI and MONGODB-X509, and the database name or “$external” for PLAIN.

password: Option<String>

The password to authenticate with. This does not apply to all mechanisms.

mechanism: Option<AuthMechanism>

Which authentication mechanism to use. If not provided, one will be negotiated with the server.

mechanism_properties: Option<Document>

Additional properties for the given mechanism.

Implementations

impl Credential

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

Create a builder for building Credential. On the builder, call .username(...)(optional), .source(...)(optional), .password(...)(optional), .mechanism(...)(optional), .mechanism_properties(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of Credential.

Trait Implementations

impl Clone for Credential

fn clone(&self) -> Credential

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Credential

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

Formats the value using the given formatter.

impl Default for Credential

fn default() -> Credential

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Credential

fn deserialize<__D>(
    __deserializer: __D
) -> Result<Credential, <__D as Deserializer<'de>>::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<Credential> for Credential

fn eq(&self, other: &Credential) -> 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 Credential