rskit-storage 0.2.0-alpha.3

File I/O, local storage, temp files, MIME detection, and storage backend traits
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

# rskit-storage

File I/O, local storage, temp files, MIME detection, and the shared storage backend registry.

[![CI](https://github.com/kbukum/rskit/actions/workflows/ci.yml/badge.svg)](https://github.com/kbukum/rskit/actions/workflows/ci.yml) [![crates.io](https://img.shields.io/crates/v/rskit-storage.svg)](https://crates.io/crates/rskit-storage) [![docs.rs](https://docs.rs/rskit-storage/badge.svg)](https://docs.rs/rskit-storage) [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/kbukum/rskit/blob/main/LICENSE) [![MSRV: 1.91](https://img.shields.io/badge/MSRV-1.91-orange.svg)](https://github.com/kbukum/rskit/blob/main/core/Cargo.toml)

## Capabilities

- `FileSource` — unified reference to local path, URL, bytes, or temp file
- `FileSink` / `FileWriter` — buffered output destinations
- `FileMeta`, `FileKind` — metadata and broad category detection (Video, Audio, Image, …)
- `detect_mime` / `detect_kind` — magic-byte + extension fallback
- `FileStore` trait with a local filesystem backend
- `StorageRegistry` for explicit, config-driven backend selection
- local backend keys and write targets are confined under the configured root and reject `..`,
  absolute path escapes, and symlink traversal before creating parent directories
- `TempFile` / `TempDir` — RAII-managed temporaries (auto-deleted on drop)
- Async streaming reads and file transfers

Cloud backends live in opt-in adapter crates:

- `rskit-storage-s3` for Amazon S3 and S3-compatible stores
- `rskit-storage-gcs` for Google Cloud Storage

Adapter crates register through an application-owned `StorageRegistry`;
importing an adapter crate has no side effects.

## Usage

```toml
[dependencies]
rskit-storage = "0.2.0-alpha.3"
```

```rust
use rskit_storage::{FileSource, detect_kind, FileKind, TempFile};
use rskit_errors::AppResult;

async fn example() -> AppResult<()> {
    let src = FileSource::from_path("photo.jpg");
    let kind = detect_kind(&src).await?;
    assert!(matches!(kind, FileKind::Image));

    let tmp = TempFile::new("upload", ".jpg")?;
    println!("temp path: {:?}", tmp.path());
    // tmp is deleted when dropped
    Ok(())
}
```

## Backend registry

```rust,no_run
use rskit_storage::{
    LocalStoreConfig, StorageConfig, StorageRegistry, register_local,
};

# async fn example() -> rskit_errors::AppResult<()> {
let mut registry = StorageRegistry::new();
register_local(&mut registry)?;

let store = registry
    .build(&StorageConfig {
        backend: "local".into(),
        local: LocalStoreConfig {
            root_dir: "data".into(),
            auto_create: true,
        },
    })
    .await?;
# Ok(())
# }
```

## See Also

[Main repository README](https://github.com/kbukum/rskit)