asepharyana
5717f8aaaa
CI / Rustfmt (push) Canceled after 0s
CI / Clippy (push) Canceled after 0s
CI / Test (workspace all features) (push) Canceled after 0s
CI / Test (workspace default features) (push) Canceled after 0s
CI / Test (mytheclipse / bg only) (push) Canceled after 0s
CI / Test (mytheclipse / compute only) (push) Canceled after 0s
CI / Test (mytheclipse / io only) (push) Canceled after 0s
CI / Test (mytheclipse / lifecycle only) (push) Canceled after 0s
CI / Test (mytheclipse / observability only) (push) Canceled after 0s
CI / Test (mytheclipse / resiliency only) (push) Canceled after 0s
CI / Test (mytheclipse / traffic only) (push) Canceled after 0s
CI / Test (mytheclipse-cache / l2-redis) (push) Canceled after 0s
CI / Test (mytheclipse-cache / l1-moka) (push) Canceled after 0s
CI / Test (mytheclipse-cache / default) (push) Canceled after 0s
CI / Test (mytheclipse-config / default) (push) Canceled after 0s
CI / Test (mytheclipse-crypto / default) (push) Canceled after 0s
CI / Test (mytheclipse-event / amqp) (push) Canceled after 0s
CI / Test (mytheclipse-event / nats) (push) Canceled after 0s
CI / Test (mytheclipse-event / default (mem)) (push) Canceled after 0s
CI / Test (mytheclipse-storage / gcs) (push) Canceled after 0s
CI / Test (mytheclipse-storage / s3) (push) Canceled after 0s
CI / Test (mytheclipse-storage / default (local)) (push) Canceled after 0s
CI / Run mytheclipse example (push) Canceled after 0s
CI / Docs check (push) Canceled after 0s
CI / Cargo package dry-run (mytheclipse) (push) Canceled after 0s
CI / Cargo package dry-run (mytheclipse-cache) (push) Canceled after 0s
CI / Cargo package dry-run (mytheclipse-config) (push) Canceled after 0s
CI / Cargo package dry-run (mytheclipse-crypto) (push) Canceled after 0s
CI / Cargo package dry-run (mytheclipse-event) (push) Canceled after 0s
CI / Cargo package dry-run (mytheclipse-storage) (push) Canceled after 0s
Release / Semantic Release (push) Canceled after 0s
Same E0432 class as mytheclipse-event: the crate-root doctests referenced feature-gated types that are absent in reduced-feature test builds flagged by the CI matrix. - mytheclipse-cache: example used MemoryCache (l1-memory) plus MultiLayerCache/CacheAside (cache-aside); the l1-moka and l2-redis builds (which don't enable cache-aside) failed the doctest. Gated the body behind all(l1-memory, cache-aside) with a no-op fallback. - mytheclipse-storage: example used LocalFileStorage (local feature); the gcs and s3 builds failed the doctest. Gated the body behind the local feature with a no-op fallback. Examples remain compile-checked & runnable under default features.
59 lines
1.7 KiB
Rust
59 lines
1.7 KiB
Rust
//! # mytheclipse-storage
|
|
//!
|
|
//! A unified storage & file system abstraction so file handling doesn't get
|
|
//! locked to one physical storage location.
|
|
//!
|
|
//! - **Local disk** ([`local::LocalFileStorage`], feature `local`, default).
|
|
//! - **S3-compatible object storage** ([`s3::S3Storage`], feature `s3`) —
|
|
//! works with Amazon S3 and any S3-compatible endpoint, including MinIO
|
|
//! (pass a custom endpoint via [`s3::S3Storage::connect_with_endpoint`]).
|
|
//! - **Google Cloud Storage** ([`gcs::GcsStorage`], feature `gcs`).
|
|
//!
|
|
//! All operations are stream-based (an [`traits::ObjectStream`] is a boxed
|
|
//! [`tokio::io::AsyncRead`]), so uploading/downloading a huge object never
|
|
//! requires holding it entirely in memory.
|
|
//!
|
|
//! ## Example
|
|
//!
|
|
//! Local disk storage (`local` feature, default):
|
|
//!
|
|
//! ```no_run
|
|
//! use mytheclipse_storage::{StorageDriver, bytes_stream, read_to_vec};
|
|
//! # #[cfg(feature = "local")]
|
|
//! # #[tokio::main]
|
|
//! # async fn main() {
|
|
//! use mytheclipse_storage::LocalFileStorage;
|
|
//! # let dir = tempfile::tempdir().unwrap();
|
|
//! let storage = LocalFileStorage::new(dir.path());
|
|
//! storage.put("hello.txt", bytes_stream(b"hi".to_vec())).await.unwrap();
|
|
//! let data = read_to_vec(storage.get("hello.txt").await.unwrap()).await.unwrap();
|
|
//! assert_eq!(data, b"hi");
|
|
//! # }
|
|
//! # #[cfg(not(feature = "local"))]
|
|
//! # fn main() {}
|
|
//! ```
|
|
|
|
pub mod traits;
|
|
|
|
#[cfg(feature = "local")]
|
|
pub mod local;
|
|
|
|
#[cfg(feature = "s3")]
|
|
pub mod s3;
|
|
|
|
#[cfg(feature = "gcs")]
|
|
pub mod gcs;
|
|
|
|
pub use traits::{
|
|
bytes_stream, read_to_vec, ObjectMeta, ObjectStream, StorageDriver, StorageError,
|
|
};
|
|
|
|
#[cfg(feature = "local")]
|
|
pub use local::LocalFileStorage;
|
|
|
|
#[cfg(feature = "s3")]
|
|
pub use s3::S3Storage;
|
|
|
|
#[cfg(feature = "gcs")]
|
|
pub use gcs::GcsStorage;
|