Struct SecretDefinition 

pub struct SecretDefinition {
    pub key: String,
    pub description: Option<String>,
    pub required: bool,
    pub provider: Option<String>,
    pub env_var: Option<String>,
    pub file_path: Option<String>,
    pub file_mode: Option<String>,
}

Definition of a single secret.

Fields

key: String

Secret key name.

description: Option<String>

Human-readable description.

required: bool

Whether this secret is required.

provider: Option<String>

Provider to use (defaults to platform keychain).

env_var: Option<String>

Environment variable name to inject as.

file_path: Option<String>

File path to write secret to (for file-based secrets).

file_mode: Option<String>

File permissions (octal, e.g., “0600”).

Implementations

impl SecretDefinition

pub fn required(key: impl Into<String>) -> Self

Create a new required secret definition.

pub fn optional(key: impl Into<String>) -> Self

Create a new optional secret definition.

pub fn with_description(self, description: impl Into<String>) -> Self

Set the description.

pub fn with_provider(self, provider: impl Into<String>) -> Self

Set the provider.

pub fn inject_as_env(self, env_var: impl Into<String>) -> Self

Set the environment variable to inject as.

pub fn write_to_file(self, path: impl Into<String>) -> Self

Set the file path to write to.

pub fn with_file_mode(self, mode: impl Into<String>) -> Self

Set the file mode.

pub fn has_env_var(&self) -> bool

Check if this secret should be injected as an environment variable.

pub fn has_file_path(&self) -> bool

Check if this secret should be written to a file.

pub fn injection_targets(&self) -> Vec<SecretInjectionTarget>

Get the injection targets for this secret.

Trait Implementations

impl Clone for SecretDefinition

fn clone(&self) -> SecretDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecretDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SecretDefinition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SecretDefinition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.