Struct PasswordConfig

pub struct PasswordConfig(pub Secret);

The password configuration.

Tuple Fields

0: Secret

Implementations

impl PasswordConfig

pub async fn reset(&self) -> Result<()>

If the current password secret is a keyring entry, delete it.

pub async fn configure<F>(&self, get_passwd: F) -> Result<()>

where F: Fn() -> Result<String>,

Define the password only if it does not exist in the keyring.

Methods from Deref<Target = Secret>

pub fn is_empty(&self) -> bool

Returns true if the secret is empty.

pub async fn get(&self) -> Result<String, Error>

Gets the secret value.

The command-based secret execute its shell command and returns the output, and the keyring-based secret retrieves the value from the global keyring using its inner key.

pub async fn find(&self) -> Result<Option<String>, Error>

Finds the secret value.

Like Secret::get, but returns None if the secret value is not found or empty.

pub async fn set(&mut self, secret: impl ToString) -> Result<String, Error>

Updates the secret value.

This is only applicable for raw secrets and keyring-based secrets. A secret value cannot be changed for command-base secrets, since the value is the output of the command.

pub async fn set_if_keyring( &self, secret: impl ToString, ) -> Result<String, Error>

Updates the secret value of the keyring-based secret only.

This function as no effect on other secret variants.

pub async fn delete(&mut self) -> Result<(), Error>

Deletes the secret value and make the current secret empty.

pub async fn delete_if_keyring(&self) -> Result<(), Error>

Deletes the secret value of keyring-based secrets only.

This function has no effect on other variants.

pub fn replace_if_empty(&mut self, new: Secret)

Replaces empty secret variant with the given one.

This function has no effect on other variants.

pub fn replace_with_keyring_if_empty( &mut self, entry: impl ToString, ) -> Result<(), Error>

Replaces empty secret variant with a keyring one.

This function has no effect on other variants.

Trait Implementations

impl Clone for PasswordConfig

fn clone(&self) -> PasswordConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PasswordConfig

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

Formats the value using the given formatter.

impl Default for PasswordConfig

fn default() -> PasswordConfig

Returns the “default value” for a type.

impl Deref for PasswordConfig

type Target = Secret

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for PasswordConfig

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for PasswordConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PasswordConfig

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for PasswordConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PasswordConfig

impl StructuralPartialEq for PasswordConfig