Struct indexed_file::file::File

pub struct File(_);

A wrapper around std::fs::File which implements ReadByLine and holds an index of the lines.

Implementations

impl File

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

Open a new indexed file.

Returns an error if the index is malformed, missing or an io error occurs

pub fn open_raw<P: AsRef<Path>>(path: P) -> Result<File>

Open a non indexed file and generates the index.

pub fn open_custom<P: AsRef<Path>>(path: P, index: Arc<Index>) -> Result<File>

Open a non indexed file and uses a custom index index. Expects the index to be properly built.

pub fn from_buf_reader(reader: BufReader<File>, index: Arc<Index>) -> File

Creates a new File using an existing _std::io::BufReader and index

pub fn read_all(&mut self, buf: &mut Vec<u8>) -> Result<usize>

Read the whole file into a String

Trait Implementations

impl Debug for File

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Indexable for File

fn get_index(&self) -> &Index

Returns a reference to the files index.

fn total_lines(&self) -> usize

Returns the total amount of lines in the file without the lines used by the index.

fn get_index_byte_len(&self) -> usize

impl IndexableFile for File

fn read_current_line(&mut self, buf: &mut Vec<u8>, line: usize) -> Result<usize>

Should read from the current position until the end of the line, omitting the \n

fn seek_line(&mut self, line: usize) -> Result<()>

Should seek the file to the given line line

fn write_to<W: Write + Unpin + Send>(&mut self, writer: &mut W) -> Result<usize>

Write the index, followed by the files contents into writer. A file generated using this function will always be parsable by File::open.

fn get_offset(&self, line: usize) -> Result<u64>

Should return the offset to seek to given the line-index

impl ReadByLine for File

fn read_line(&mut self, line: usize) -> Result<String>

Reads the given line

fn read_line_raw(&mut self, line: usize, buf: &mut Vec<u8>) -> Result<usize>

Reads the given line and stores into buf

fn binary_search(&mut self, x: &str) -> Result<usize>

Do a binary search on ReadByLine implementing Types, since it provides everything required for binary search. Only works with sorted files

fn binary_search_by<F>(&mut self, f: F) -> Result<usize> where
    F: FnMut(&str) -> Ordering, 

Do a binary search by on ReadByLine implementing Types, since it provides everything required for binary search. Only works with sorted files

fn binary_search_raw(&mut self, x: &[u8]) -> Result<usize>

Do a binary search on ReadByLine implementing Types, since it provides everything required for binary search. Only works with sorted files

fn binary_search_raw_by<F>(&mut self, f: F) -> Result<usize> where
    F: FnMut(&[u8]) -> Ordering, 

Do a binary search by on ReadByLine implementing Types, since it provides everything required for binary search. Only works with sorted files

impl TryInto<IndexedReader<String>> for File

fn try_into(self) -> Result<IndexedString>

Convert a file into an IndexedString using the files index and reading the files contents into the memory

type Error = Error

The type returned in the event of a conversion error.

impl TryInto<IndexedReader<Vec<u8, Global>>> for File

fn try_into(self) -> Result<IndexedReader<Vec<u8>>>

Convert a file into an IndexedReader<Vec> using the files index and reading the files contents into the memory

type Error = Error

The type returned in the event of a conversion error.