Struct MappedFile

pub struct MappedFile {
    pub file: File,
    pub map: Mmap,
    pub line_ending_positions: Vec<CharPosition>,
}

A Memory Mapped File

Fields

file: File

The file that the memory map is mapped to

map: Mmap

The memory map of the file

line_ending_positions: Vec<CharPosition>

The cache of line ending positions

Implementations

impl MappedFile

pub fn new(file: File) -> Result<MappedFile, String>

Creates a new MappedFile from a File possibly returning an error

pub fn unicode_at(&mut self, index: usize) -> Result<char, IndexError>

Returns the index of the line ending at the given byte position. Returns an error if the byte position is out of bounds.