Struct Secret 

#[non_exhaustive]
pub struct Secret(/* private fields */);

Represents a secret string, such as an API key. It wraps secrecy::SecretString to prevent accidental exposure.

Example

use api_openai::Secret;

// Create from environment variable (recommended)
let secret = Secret::load_from_env("OPENAI_API_KEY")?;

// Create from string with validation
let secret = Secret::new("sk-example123".to_string())?;

// Create without validation (for testing)
let secret = Secret::new_unchecked("test-key".to_string());

Implementations

impl Secret

pub fn new(secret: String) -> Result<Self>

Creates a new Secret from a string with validation.

Errors

Returns OpenAIError::InvalidArgument if the secret format is invalid.

pub fn new_unchecked(secret: String) -> Self

Creates a new Secret from a string without validation. This should only be used when the secret format is already known to be valid.

Safety

This function bypasses validation and should only be used in controlled contexts.

pub fn load_with_path(path: &Path) -> Result<Self>

Loads a secret from a file at the given path.

Arguments

• path: The path to the file containing the secret.

Errors

Returns OpenAIError::File if the file cannot be read.

pub fn load_from_env(env_var: &str) -> Result<Self>

Loads a secret from an environment variable.

Arguments

• env_var: The name of the environment variable.

Errors

Returns OpenAIError::MissingEnvironment if the environment variable is not found.

pub fn load_from_workspace(key_name: &str, filename: &str) -> Result<Self>

Loads a secret from the centralized workspace secrets directory.

Arguments

• key_name: The name of the secret key to load.
• filename: The filename in .secrets directory (e.g., “-secrets.sh”).

Errors

Returns OpenAIError::MissingEnvironment if the secret cannot be found.

pub fn load_with_fallbacks(key_name: &str) -> Result<Self>

Load secret with comprehensive fallback chain using workspace_tools

Priority order:

1. Environment variable (fastest)
2. Workspace secrets file (main secrets file)
3. Alternative secrets files

Arguments

• key_name: The name of the secret key to load (e.g., “OPENAI_API_KEY”)

Errors

Returns OpenAIError::MissingEnvironment if the key is not found in any location

Examples

use api_openai::Secret;

// Tries environment variable first, then workspace secrets
let secret = Secret::load_with_fallbacks("OPENAI_API_KEY")?;

pub fn exposure_count() -> u64

Get the total number of secret exposures that have occurred This is useful for security auditing and monitoring

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 ExposeSecret<str> for Secret

fn expose_secret(&self) -> &str

Expose secret: this is the only method providing access to a secret.

impl From<&str> for Secret

fn from(secret: &str) -> Self

Converts to this type from the input type.

impl From<String> for Secret

fn from(secret: String) -> Self

Converts to this type from the input type.