gsadmin/rustfs
1
0
Fork 0
mirror of https://github.com/rustfs/rustfs.git synced 2026-08-30 08:49:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(io-core): add truthful buffered io aliases (#4032)

Browse Source
This commit is contained in:
Zhengchao An
2026-06-29 10:01:59 +08:00
committed by GitHub
parent 1e6f20912a
commit 5fc25eccb3
4 changed files with 91 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files
crates/io-core/src/lib.rs
+10 -11
View File
@@ -15,9 +15,9 @@
//! Buffered I/O reader and writer implementations for RustFS.
//!
//! This crate provides buffered readers and writers for I/O operations.
//! Note: despite "ZeroCopy" naming in type names (kept for backward compatibility),
//! the actual implementations perform mmap-then-copy or aligned pread, not true
//! zero-copy file I/O or true Direct I/O.
//! Prefer `BytesBufferedReader`, `BytesMutWriter`, and `AlignedPreadReader`
//! for new code. Historical `ZeroCopy*` and `DirectIo*` names remain exported
//! for backward compatibility.
//!
//! # Features
//!
@@ -30,16 +30,15 @@
//! # Example
//!
//! ```ignore
//! use rustfs_io_core::{ZeroCopyObjectReader, BytesPool};
//! use rustfs_io_core::{BytesBufferedReader, BytesPool};
//! use bytes::Bytes;
//!
//! // Create from existing bytes (zero-copy)
//! let data = Bytes::from("hello world");
//! let reader = ZeroCopyObjectReader::from_bytes(data);
//! let reader = BytesBufferedReader::from_bytes(data);
//!
//! // Create from file using mmap-then-copy (Unix only)
//! #[cfg(unix)]
//! let reader = ZeroCopyObjectReader::from_file_mmap(&file, 0, 1024).await?;
//! // Create from file using buffered reads
//! let reader = BytesBufferedReader::from_file_read(&file, 0, 1024).await?;
//!
//! // Use BytesPool
//! let pool = BytesPool::new_tiered();
@@ -62,10 +61,10 @@ pub mod timeout_wrapper;
pub mod writer;
#[cfg(target_os = "linux")]
pub use direct_io::{DirectIoError, DirectIoReader};
pub use direct_io::{AlignedPreadError, AlignedPreadReader, DirectIoError, DirectIoReader};
pub use pool::{BytesPool, BytesPoolConfig, BytesPoolMetrics, PooledBuffer};
pub use reader::{ZeroCopyObjectReader, ZeroCopyReadError};
pub use writer::{ZeroCopyObjectWriter, ZeroCopyWriteError};
pub use reader::{BytesBufferedReader, ZeroCopyObjectReader, ZeroCopyReadError};
pub use writer::{BytesMutWriter, ZeroCopyObjectWriter, ZeroCopyWriteError};
// BufReader optimizer exports
pub use bufreader_optimizer::{BufReaderConfig, BufReaderOptimizer, BufReaderStats, BufferedSource};