Skip to main content

ApiKey

Struct ApiKey 

Source
pub struct ApiKey(/* private fields */);
Expand description

API key (validated, never logged or displayed).

This type ensures API keys are:

  • Validated on construction
  • Never logged in Debug output
  • Never serialized in plain text
  • Only exposed through explicit expose() method

§Example

use simple_agent_type::validation::ApiKey;

let key = ApiKey::new("sk-1234567890abcdef1234567890").unwrap();
let debug_str = format!("{:?}", key);
assert!(debug_str.contains("REDACTED"));
assert!(!debug_str.contains("sk-"));

Implementations§

Source§

impl ApiKey

Source

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

Create a new API key with validation.

§Validation Rules
  • Must not be empty
  • Must be at least 20 characters
  • Must not contain null bytes (security)
§Example
use simple_agent_type::validation::ApiKey;

let key = ApiKey::new("sk-1234567890abcdef1234567890");
assert!(key.is_ok());

let invalid = ApiKey::new("short");
assert!(invalid.is_err());
Source

pub fn expose(&self) -> &str

Expose the raw API key.

§Security Warning

Only use this when actually making API requests. Never log or display the result.

§Example
use simple_agent_type::validation::ApiKey;

let key = ApiKey::new("sk-1234567890abcdef1234567890").unwrap();
let raw = key.expose();
assert_eq!(raw, "sk-1234567890abcdef1234567890");
Source

pub fn preview(&self) -> String

Get a redacted preview of the key (for debugging).

Shows only the prefix and length.

§Example
use simple_agent_type::validation::ApiKey;

let key = ApiKey::new("sk-1234567890abcdef1234567890").unwrap();
let preview = key.preview();
assert!(preview.contains("sk-"));
assert!(preview.contains("29 chars"));

Trait Implementations§

Source§

impl Clone for ApiKey

Source§

fn clone(&self) -> ApiKey

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ApiKey

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ApiKey

Source§

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ApiKey

Source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for ApiKey

Source§

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for ApiKey

Auto Trait Implementations§

§

impl Freeze for ApiKey

§

impl RefUnwindSafe for ApiKey

§

impl Send for ApiKey

§

impl Sync for ApiKey

§

impl Unpin for ApiKey

§

impl UnwindSafe for ApiKey

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,