Struct ApiKey 

pub struct ApiKey { /* private fields */ }

Validated API key used by provider configuration.

The key is a nonempty, syntax-valid secret; construction neither authenticates it nor proves provider permissions. Empty values, whitespace-only values, and values with leading or trailing whitespace are rejected at construction. Values must also be valid HTTP header values; embedded control characters such as newlines are rejected.

Examples

let key = providers_kit::config::ApiKey::new("sk-test")?;
assert!(!format!("{key:?}").contains("sk-test"));

Implementations

impl ApiKey

pub fn new(secret: impl Into<String>) -> Result<Self, KitError>

Validates and stores an API key.

Errors

Returns a configuration error when the secret is empty, whitespace-only, contains leading or trailing whitespace, or is not a valid HTTP header value.

Examples

let key = providers_kit::config::ApiKey::new("sk-test")?;
assert!(!format!("{key:?}").contains("sk-test"));
assert!(providers_kit::config::ApiKey::new(" padded ").is_err());
assert!(providers_kit::config::ApiKey::new("invalid\nheader").is_err());

Trait Implementations

impl Clone for ApiKey

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiKey

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

Formats the value using the given formatter.