Enum SecretLoader 

pub enum SecretLoader {
    Env(String),
    File(Utf8PathBuf),
    Plain(Secret<String>),
}

An type that can load secrets from multiple locations

This enum is the main type of this crate and represents a secret that can be loaded from multiple locations. This type can be converted to a SecretString by using SecretLoader::into_secret or one of the TryFrom<_>/TryInto<_> implementations.

Variants

Env(String)

A secret that will be loaded from an environment variable

File(Utf8PathBuf)

A secret that will be loaded from a file

Plain(Secret<String>)

A plaintext secret

Implementations

impl SecretLoader

pub fn new<S: AsRef<str>>(val: S) -> Self

Constructs a new SecretLoader from a provided str.

Examples

use secret_loader::SecretLoader;

let env_cred = SecretLoader::new("env:SECRET");
let file_cred = SecretLoader::new("file:/some/file/path");
let plain_cred = SecretLoader::new("plaintextpasswordsarebad");

pub fn into_secret(self) -> Result<Secret<String>, LoadError>

Converts a SecretLoader into a SecretString

Use this method to actually ‘load’ or ‘resolve’ a usable Secret

pub fn is_env(&self) -> bool

Returns true if the secret will be loaded from an environment variable.

assert!(SecretLoader::new("env:SECRET").is_env());

pub fn is_file(&self) -> bool

Returns true if the secret will be loaded from a file.

assert!(SecretLoader::new("file:/some/file/path").is_file());

pub fn is_plain(&self) -> bool

Returns true if the secret is in plaintext.

assert!(SecretLoader::new("plaintextpasswordsarebad").is_plain());

Trait Implementations

impl Clone for SecretLoader

fn clone(&self) -> SecretLoader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecretLoader

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SecretLoader

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<String> for SecretLoader

fn from(s: String) -> Self

Converts to this type from the input type.

impl FromStr for SecretLoader

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl TryFrom<SecretLoader> for Secret<String>

type Error = LoadError

The type returned in the event of a conversion error.

fn try_from(value: SecretLoader) -> Result<Self, Self::Error>

Performs the conversion.