Struct SecretConfig 

pub struct SecretConfig {
    pub description: Option<String>,
    pub if_missing: Option<IfMissing>,
    pub default: Option<String>,
    pub env: bool,
    pub as_file: bool,
    pub json_path: Option<String>,
    pub line: Option<usize>,
    pub sync: Option<SyncConfig>,
    pub source_path: Option<PathBuf>,
    pub source_is_profile: bool,
    /* private fields */
}

Configuration for a single secret

Fields

description: Option<String>

Description of the secret

if_missing: Option<IfMissing>

What to do if the secret is missing (error, warn, or ignore)

default: Option<String>

Default value to use if provider fails or secret is not found

env: bool

Whether to inject this secret into env vars (default: true) When false, the secret is only accessible via fnox get

as_file: bool

Write secret to a temporary file and set env var to the file path instead of the secret value

json_path: Option<String>

JSON path to extract from the secret value (supports dot notation: “nested.key”) When set, the secret value is parsed as JSON and the specified path is extracted.

line: Option<usize>

1-indexed line number to extract from the secret value. When set, the secret value is split on newlines and the Nth line is returned. Useful for providers whose entries pack multiple related values into a single secret (e.g. one value per line). Mutually exclusive with json_path.

sync: Option<SyncConfig>

Cached sync data (provider + encrypted value from fnox sync)

source_path: Option<PathBuf>

Path to the config file where this secret was defined (not serialized)

source_is_profile: bool

Whether this secret was loaded from a [profiles.X.secrets] section (not serialized). When false, the secret was loaded from a root-level [secrets] section.

Implementations

impl SecretConfig

pub fn new() -> Self

Create a new secret config with just metadata

pub fn for_raw_resolve(&self) -> Self

Return a copy that will resolve to the original provider value, skipping post-processing and cached sync values.

pub fn to_inline_table(&self) -> InlineTable

Convert this secret config to a TOML inline table for saving

pub fn write_to_table(&self, table: &mut Table)

Write this secret config into an existing TOML table while preserving that table’s header/decor and table-style representation.

pub fn update_toml_item(&self, item: &mut Item)

Update a TOML item with this secret config while preserving the item’s existing table-vs-inline-table style.

pub fn has_value(&self) -> bool

Check if this secret has any value (provider, value, or default)

pub fn provider(&self) -> Option<&str>

Get the provider name, if set.

pub fn provider_span(&self) -> Option<Range<usize>>

Get the provider’s source span (byte range in the config file). Returns None if the provider wasn’t set or was created programmatically.

pub fn set_provider(&mut self, provider: Option<String>)

Set the provider name (without span information).

pub fn value(&self) -> Option<&str>

Get the value, if set.

pub fn set_value(&mut self, value: Option<String>)

Set the value (without span information).

Trait Implementations

impl Clone for SecretConfig

fn clone(&self) -> SecretConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecretConfig

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

Formats the value using the given formatter.

impl Default for SecretConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SecretConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for SecretConfig

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for SecretConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.