Enum Secret

pub enum Secret {
    Empty,
    Raw(String),
    Command(Command),
    Keyring(KeyringEntry),
}

The secret.

A secret can be retrieved either from a raw string, from a shell command or from a keyring entry.

Variants

Empty

The secret is empty.

Raw(String)

The secret is contained in a raw string.

This variant is not safe to use and therefore not recommended. Yet it works well for testing purpose.

Command(Command)

The secret is exposed by the given shell command.

This variant takes the secret from the first line returned by the given shell command.

See process-lib.

Keyring(KeyringEntry)

The secret is contained in the user’s global keyring at the given entry.

See keyring-lib.

Implementations

impl Secret

pub fn new() -> Self

Creates a new empty secret.

pub fn new_raw(raw: impl ToString) -> Self

Creates a new secret from the given raw string.

pub fn new_command(cmd: impl ToString) -> Self

Creates a new secret from the given shell command.

pub fn new_keyring_entry(entry: KeyringEntry) -> Self

Creates a new secret from the given keyring entry.

pub fn try_new_keyring_entry( entry: impl TryInto<KeyringEntry, Error = Error>, ) -> Result<Self>

Tries to create a new secret from the given entry.

pub fn is_empty(&self) -> bool

Returns true if the secret is empty.

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

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>>

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>

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>

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<()>

Deletes the secret value and make the current secret empty.

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

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: Self)

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<()>

Replaces empty secret variant with a keyring one.

This function has no effect on other variants.

Trait Implementations

impl Clone for Secret

fn clone(&self) -> Secret

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Secret

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

Formats the value using the given formatter.

impl Default for Secret

fn default() -> Secret

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Secret

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Secret

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

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 Secret

impl StructuralPartialEq for Secret