Struct file_chunker::FileChunker

pub struct FileChunker { /* private fields */ }

Implementations

impl FileChunker

pub fn new(file: &File) -> Result<Self>

Create a new FileChunker

pub fn chunks(
    &self,
    count: usize,
    delimiter: Option<char>
) -> Result<Vec<&[u8]>>

Divide the file into chunks approximately equal size. Returns a vector of memory-mapped slices that each correspond to a chunk.

If a delimeter is provided, then each chunk will end with an instance of the delimeter, assuming the delimiter exists in the file. This is useful when working with text files that have newline characters, for example. If no delimeter is provided, then each chunk will be the same size, except for the last chunk which may be smaller.

It is assumed that the underlying File will not change while this function is running.