farena 0.2.0

A file-backed arena allocator using pread for RSS-conscious byte storage
Documentation
//! File-backed arena allocator using `pread(2)` for RSS-conscious byte storage.
//!
//! # Usage
//!
//! ```rust
//! use farena::{FileArena, FileArenaWriter};
//!
//! // Write phase — file_index 0
//! let mut writer = FileArenaWriter::new(0)?;
//! let loc1 = writer.push("hello")?;
//! let loc2 = writer.push(" world")?;
//! let file = writer.finish()?;
//!
//! // Read phase
//! let arena = FileArena::new(vec![file])?;
//! assert_eq!(arena.get(loc1)?, b"hello");
//! assert_eq!(arena.get(loc2)?, b" world");
//! # Ok::<_, std::io::Error>(())
//! ```
//!
//! # Multiple files (parallel writers)
//!
//! Assign each writer its future index upfront, then collect files in that order:
//!
//! ```rust
//! # use farena::{FileArena, FileArenaWriter};
//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
//! let mut w0 = FileArenaWriter::new(0)?;
//! let loc0 = w0.push("data0")?;
//! let f0 = w0.finish()?;
//!
//! let mut w1 = FileArenaWriter::new(1)?;
//! let loc1 = w1.push("data1")?;
//! let f1 = w1.finish()?;
//!
//! // files must be in index order
//! let arena = FileArena::new(vec![f0, f1])?;
//! assert_eq!(arena.get(loc0)?, b"data0");
//! assert_eq!(arena.get(loc1)?, b"data1");
//! # Ok(())
//! # }
//! ```

mod arena;
mod location;
mod writer;

pub use arena::FileArena;
pub use location::Location;
pub use writer::FileArenaWriter;