wordval_fs/lib.rs
1//! # wordval-fs
2//!
3//! Wordval 文件存储:本地文件系统、MinIO 等多种后端。
4//!
5//! ## 支持的后端
6//!
7//! - `LocalFs` — 本地文件系统存储
8//! - `MinioFs` — MinIO 对象存储(`minio` feature,默认启用)
9//! - `FsBackendEnum::Custom` — 任意实现 [`FsBackend`] 的自定义后端
10//!
11//! ## 作为插件使用
12//!
13//! ```ignore
14//! use wordval_fs::FsPlugin;
15//!
16//! let mgr = PluginManager::new()
17//! .add(FsPlugin::new(&config.fs));
18//! ```
19//!
20//! ## 直接使用
21//!
22//! ```ignore
23//! use wordval_fs::{LocalFs, FsBackend, FsBackendEnum};
24//!
25//! let backend = FsBackendEnum::Local(std::sync::Arc::new(LocalFs::new("./uploads")));
26//! let meta = backend.write("path/to/file.txt", b"hello").await?;
27//! let data = backend.read("path/to/file.txt").await?;
28//! ```
29//!
30//! ## 自定义后端扩展
31//!
32//! 实现 [`FsBackend`] trait 后包装为 `FsBackendEnum::Custom` 即可接入
33//! (如 FTP、WebDAV 等协议后端),无需修改本 crate:
34//!
35//! ```ignore
36//! struct FtpFs { /* 连接配置 */ }
37//!
38//! #[async_trait::async_trait]
39//! impl FsBackend for FtpFs {
40//! fn backend_name(&self) -> &str { "ftp" }
41//! async fn write(&self, relative_path: &str, data: &[u8]) -> StoreResult<FileMeta> { /* ... */ }
42//! // read / delete / exists / list 同理
43//! }
44//!
45//! let backend = FsBackendEnum::Custom(std::sync::Arc::new(FtpFs::new()));
46//! ```
47
48pub mod backend;
49pub mod local;
50#[cfg(feature = "minio")]
51pub mod minio;
52pub mod plugin;
53pub mod types;
54
55pub use backend::{FsBackend, FsBackendEnum};
56pub use local::LocalFs;
57#[cfg(feature = "minio")]
58pub use minio::MinioFs;
59pub use plugin::FsPlugin;
60pub use types::{FileEntry, FileMeta, StoreResult};