Struct mongodb::options::Credential [−][src]
#[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>,
}
tokio-runtime
and non-crate feature async-std-runtime
, or non-crate feature tokio-runtime
and crate feature async-std-runtime
only.Expand description
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)
This struct is marked as non-exhaustive
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
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
Returns the “default value” for a type. Read more
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for Credential
impl Send for Credential
impl Sync for Credential
impl Unpin for Credential
impl UnwindSafe for Credential
Blanket Implementations
Mutably borrows from an owned value. Read more