file_rw

file_rw is a Rust crate for high-performance, memory-mapped file I/O utilities.

Features

• High-performance file reading and writing capabilities
• Memory-mapped files for efficient access and manipulation
• High-level, efficient abstractions of common operations on file contents

Installation

You can include the crate in your Rust project by either:

• Adding the following to your Cargo.toml file:

[dependencies]
file_rw = "0.4.5"

• Running the following Cargo command to automatically do so:

cargo add file_rw

Modules

• file: File operations
• read: File reading capabilities
• write: File writing capabilities

Re-exports

The crate re-exports the FileReader and FileWriter structs for external use. These structs contain the aforementioned utilities.

Examples

use file_rw::{FileReader, FileWriter};
use tempfile::tempdir;

let tempdir = tempdir().unwrap();
let tempdir_path = tempdir.path();
let test_path = tempdir_path.join("test.txt");
let mut writer = FileWriter::open(&test_path).unwrap();

writer.append("Hello World!");
assert_eq!(writer.bytes(), b"Hello World!");

writer.overwrite("Hello");
assert_eq!(writer.bytes(), b"Hello");

writer.write("Hullo");
assert_eq!(writer.bytes(), b"Hullo");

writer.find_replace_nth("l", "y", 0).unwrap();
assert_eq!(writer.bytes(), b"Huylo");

writer.find_replace("u", "e").unwrap();
assert_eq!(writer.bytes(), b"Heylo");

writer.find_replace("lo", "yyy").unwrap();
assert_eq!(writer.bytes(), b"Heyyyy");

writer.find_replace_all("y", "i").unwrap();
assert_eq!(writer.bytes(), b"Heiiii");

writer.find_replace("e", "i").unwrap();
assert_eq!(writer.bytes(), b"Hiiiii");

let reader = writer.as_reader().unwrap();
let content = reader.read_to_string();
assert_eq!(content, "Hiiiii");