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

//! # modo::storage
//!
//! S3-compatible object storage.
//!
//! This module provides [`Storage`], a thin facade over S3-compatible backends
//! (AWS S3, RustFS, MinIO, etc.). Features include upload from bytes or URL,
//! presigned URLs, configurable ACLs, and file-size limits.
//!
//! ## Provides
//!
//! | Type | Purpose |
//! |------|---------|
//! | [`Storage`] | Single-bucket handle — upload, delete, public URL, presigned URL |
//! | [`Buckets`] | Named collection of `Storage` instances for multi-bucket apps |
//! | [`PutInput`] | Input for [`Storage::put()`] / [`Storage::put_with()`] |
//! | [`PutFromUrlInput`] | Input for [`Storage::put_from_url()`] / [`Storage::put_from_url_with()`] |
//! | [`PutOptions`] | Optional headers and ACL override for uploads |
//! | [`Acl`] | Access control: `Private` (default) or `PublicRead` |
//! | [`BucketConfig`] | Deserialisable configuration for one bucket |
//! | [`kb()`] / [`mb()`] / [`gb()`] | Size-unit helpers (bytes conversion) |
//!
//! Use [`Storage::with_client()`] to share a [`reqwest::Client`] connection pool
//! across multiple `Storage` instances or other modules.
//!
//! ## Quick start
//!
//! ```rust,no_run
//! use modo::storage::{BucketConfig, Storage, PutInput};
//!
//! # fn example() -> modo::Result<()> {
//! let mut config = BucketConfig::default();
//! config.bucket = "my-bucket".into();
//! config.endpoint = "https://s3.amazonaws.com".into();
//! config.access_key = "AKIAIOSFODNN7EXAMPLE".into();
//! config.secret_key = "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY".into();
//! config.region = Some("us-east-1".into());
//! config.public_url = Some("https://cdn.example.com".into());
//! config.max_file_size = Some("10mb".into());
//! let storage = Storage::new(&config)?;
//! # Ok(())
//! # }
//! ```
//!
//! ## Request signing
//!
//! All requests are signed with AWS Signature Version 4. Both path-style
//! (`https://endpoint/bucket/key`) and virtual-hosted-style
//! (`https://bucket.endpoint/key`) URLs are supported via the
//! `path_style` field in [`BucketConfig`].

mod backend;
mod bridge;
mod buckets;
mod client;
mod config;
mod facade;
mod fetch;
pub(crate) mod memory;
mod options;
mod path;
mod presign;
mod signing;

pub use buckets::Buckets;
pub use config::BucketConfig;
pub use config::{gb, kb, mb};
pub use facade::{PutFromUrlInput, PutInput, Storage};
pub use options::{Acl, PutOptions};