gsadmin/rustfs
1
0
Fork 0
mirror of https://github.com/rustfs/rustfs.git synced 2026-08-20 19:42:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add documentation to storage-api public types (#741) (#4007)

Browse Source 
docs: add documentation to storage-api public types

Add doc comments to public structs, enums, and traits in
storage-api crate to improve documentation coverage.

Refs #741
This commit is contained in:
Zhengchao An
2026-06-28 19:12:02 +08:00
committed by GitHub
parent 1f56ddf913
commit 27b8592879
3 changed files with 53 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
crates/storage-api/src/error.rs
+5
View File
@@ -14,8 +14,13 @@
//! Stable storage error contracts shared across storage consumers.
/// Result type alias for storage operations.
pub type StorageResult<T, E = StorageErrorCode> = core::result::Result<T, E>;
/// Error codes for storage operations.
///
/// These codes provide a stable, cross-crate error classification
/// that can be serialized and transmitted between nodes.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum StorageErrorCode {
Io,