Enum FileReader 

pub enum FileReader {
    Mmap {
        file: File,
        mmap: Mmap,
    },
    Buffered {
        data: Vec<u8>,
    },
}

File reader that supports both memory-mapped and buffered reading

Variants

Mmap

Memory-mapped file

Fields

file: File

File handle (kept alive to ensure mmap validity)

mmap: Mmap

Memory-mapped region

Buffered

Buffered file data

Fields

data: Vec<u8>

File contents loaded into memory

Implementations

impl FileReader

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self>

Open a file using the default policy (auto with 10MB threshold)

Errors

Returns anyhow::Error when the file cannot be opened, memory-mapped, or read.

pub fn open_with_policy<P: AsRef<Path>>( path: P, policy: ReaderPolicy, ) -> Result<Self>

Open a file with a specific reading policy

Errors

Returns anyhow::Error when file metadata access, mmap, or buffered reads fail. Also returns error if file exceeds the maximum source file size limit (RR-10 DoS prevention).

pub fn as_slice(&self) -> &[u8]

Get a slice of the file contents

pub fn len(&self) -> usize

Get the size of the file in bytes

pub fn is_empty(&self) -> bool

Check if the file is empty

pub fn chunks(&self, chunk_size: usize) -> impl Iterator<Item = &[u8]>

Iterate over chunks of the file

Trait Implementations

impl AsRef<[u8]> for FileReader

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.