Struct ApiKey 

pub struct ApiKey {
    pub key: String,
    pub name: String,
    pub permissions: Vec<Permission>,
    pub rate_limit_per_minute: Option<u64>,
    pub rate_limit_per_hour: Option<u64>,
    pub rate_limit_per_day: Option<u64>,
    pub total_quota: Option<u64>,
    pub bytes_quota: Option<u64>,
    pub active: bool,
    pub created_at: u64,
    pub expires_at: Option<u64>,
    pub metadata: HashMap<String, String>,
}

API key with associated permissions and quotas

Fields

key: String

Unique key identifier

name: String

Human-readable name

permissions: Vec<Permission>

Permissions granted to this key

rate_limit_per_minute: Option<u64>

Rate limit (requests per minute)

rate_limit_per_hour: Option<u64>

Rate limit (requests per hour)

rate_limit_per_day: Option<u64>

Rate limit (requests per day)

total_quota: Option<u64>

Total quota (maximum total requests)

bytes_quota: Option<u64>

Bytes quota (maximum bytes processed)

active: bool

Whether the key is active

created_at: u64

Creation timestamp (Unix timestamp in seconds)

expires_at: Option<u64>

Expiration timestamp (Unix timestamp in seconds, None = never expires)

metadata: HashMap<String, String>

Optional metadata

Implementations

impl ApiKey

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

Create a new API key

pub fn with_permissions(self, permissions: Vec<Permission>) -> Self

Set permissions

pub fn with_rate_limit_per_minute(self, limit: u64) -> Self

Set rate limit per minute

pub fn with_rate_limit_per_hour(self, limit: u64) -> Self

Set rate limit per hour

pub fn with_rate_limit_per_day(self, limit: u64) -> Self

Set rate limit per day

pub fn with_total_quota(self, quota: u64) -> Self

Set total quota

pub fn with_bytes_quota(self, quota: u64) -> Self

Set bytes quota

pub fn with_expiration(self, expires_at: u64) -> Self

Set expiration time

pub fn with_metadata( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Add metadata

pub fn has_permission(&self, permission: Permission) -> bool

Check if the key has a specific permission

pub fn is_expired(&self) -> bool

Check if the key is expired

pub fn is_valid(&self) -> bool

Check if the key is valid (active and not expired)

Trait Implementations

impl Clone for ApiKey

fn clone(&self) -> ApiKey

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.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ApiKey

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

where __S: Serializer,

Serialize this value into the given Serde serializer.