atlas-common 0.1.1

Common functionality for Atlas ML provenance system
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
80
81
82
83
84
85
86
87
88
89
90
91
92

//! Storage backend trait definition

use crate::error::Result;
use std::any::Any;

/// Storage backend trait for different storage implementations
///
/// This trait provides a common interface for storage operations
/// across different backend types (filesystem, S3, database, etc.).
///
/// # Async Support
///
/// When the `async` feature is enabled, all methods become async.
#[cfg_attr(feature = "async", async_trait::async_trait)]
pub trait StorageBackend: Send + Sync {
    /// Store data with an ID
    ///
    /// # Arguments
    ///
    /// * `id` - Unique identifier for the data
    /// * `data` - Raw bytes to store
    ///
    /// # Errors
    ///
    /// Returns an error if storage fails.
    #[cfg(not(feature = "async"))]
    fn store(&self, id: &str, data: &[u8]) -> Result<()>;

    #[cfg(feature = "async")]
    async fn store(&self, id: &str, data: &[u8]) -> Result<()>;

    /// Retrieve data by ID
    ///
    /// # Arguments
    ///
    /// * `id` - Unique identifier of the data to retrieve
    ///
    /// # Errors
    ///
    /// Returns an error if the ID is not found or retrieval fails.
    #[cfg(not(feature = "async"))]
    fn retrieve(&self, id: &str) -> Result<Vec<u8>>;

    #[cfg(feature = "async")]
    async fn retrieve(&self, id: &str) -> Result<Vec<u8>>;

    /// List all stored IDs
    ///
    /// # Errors
    ///
    /// Returns an error if listing fails.
    #[cfg(not(feature = "async"))]
    fn list(&self) -> Result<Vec<String>>;

    #[cfg(feature = "async")]
    async fn list(&self) -> Result<Vec<String>>;

    /// Delete data by ID
    ///
    /// # Arguments
    ///
    /// * `id` - Unique identifier of the data to delete
    ///
    /// # Errors
    ///
    /// Returns an error if deletion fails.
    #[cfg(not(feature = "async"))]
    fn delete(&self, id: &str) -> Result<()>;

    #[cfg(feature = "async")]
    async fn delete(&self, id: &str) -> Result<()>;

    /// Check if ID exists
    ///
    /// # Arguments
    ///
    /// * `id` - Unique identifier to check
    ///
    /// # Errors
    ///
    /// Returns an error if the check fails.
    #[cfg(not(feature = "async"))]
    fn exists(&self, id: &str) -> Result<bool>;

    #[cfg(feature = "async")]
    async fn exists(&self, id: &str) -> Result<bool>;

    /// Get as Any for downcasting
    ///
    /// Allows runtime type checking and casting to concrete types.
    fn as_any(&self) -> &dyn Any;
}