modo-rs 0.8.0

Rust web framework for small monolithic apps
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

use std::future::Future;
use std::pin::Pin;

use crate::error::Result;

use super::types::ApiKeyRecord;

/// Thin storage backend for API keys.
///
/// Implementations handle only CRUD operations. All business logic
/// (key generation, hashing, verification, expiry checks, touch throttling)
/// lives in [`super::ApiKeyStore`].
///
/// The built-in SQLite backend is used automatically by
/// [`ApiKeyStore::new`](super::ApiKeyStore::new). Custom backends
/// (Postgres, Redis, etc.) implement this trait and pass an `Arc<dyn
/// ApiKeyBackend>` to [`ApiKeyStore::from_backend`](super::ApiKeyStore::from_backend).
pub trait ApiKeyBackend: Send + Sync {
    /// Store a new key record.
    ///
    /// # Errors
    ///
    /// Returns an error if the underlying storage operation fails.
    fn store(&self, record: &ApiKeyRecord)
    -> Pin<Box<dyn Future<Output = Result<()>> + Send + '_>>;

    /// Look up a key by ULID. Returns `None` if not found.
    ///
    /// # Errors
    ///
    /// Returns an error if the underlying storage operation fails.
    fn lookup(
        &self,
        key_id: &str,
    ) -> Pin<Box<dyn Future<Output = Result<Option<ApiKeyRecord>>> + Send + '_>>;

    /// Set `revoked_at` on a key.
    ///
    /// # Errors
    ///
    /// Returns an error if the underlying storage operation fails.
    fn revoke(
        &self,
        key_id: &str,
        revoked_at: &str,
    ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + '_>>;

    /// List all keys for a tenant.
    ///
    /// # Errors
    ///
    /// Returns an error if the underlying storage operation fails.
    fn list(
        &self,
        tenant_id: &str,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<ApiKeyRecord>>> + Send + '_>>;

    /// Update `last_used_at` timestamp.
    ///
    /// # Errors
    ///
    /// Returns an error if the underlying storage operation fails.
    fn update_last_used(
        &self,
        key_id: &str,
        timestamp: &str,
    ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + '_>>;

    /// Update `expires_at` timestamp (refresh).
    ///
    /// # Errors
    ///
    /// Returns an error if the underlying storage operation fails.
    fn update_expires_at(
        &self,
        key_id: &str,
        expires_at: Option<&str>,
    ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + '_>>;
}