Struct indexed_file::bufreader::IndexedBufReader

pub struct IndexedBufReader<R: Read + Unpin + Seek + Send> {
    pub reader: BufReader<R>,
    // some fields omitted
}

A wrapper around BufReader<R> which implements ReadByLine and holds an index of the lines.

Fields

reader: BufReader<R>

Implementations

impl<R: Read + Unpin + Seek + Send> IndexedBufReader<R>

pub fn new(reader: BufReader<R>, index: Arc<Index>) -> IndexedBufReader<R>

Creates a new IndexedBufReader using a BufReader and an index. The index won’t be validated. Using a malformed index won’t return an error but make the IndexedBufReader useless.

pub fn duplicate(&self, reader: BufReader<R>) -> Self

Creates a new IndexedBufReader with the current index. reader should contain the same data used in &self or the index might be invalid for the given reader

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

Read the IndexedBufReader into a newly allocated string

Trait Implementations

impl<R: Debug + Read + Unpin + Seek + Send> Debug for IndexedBufReader<R>

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

Formats the value using the given formatter.

impl<R: Read + Unpin + Seek + Send> Indexable for IndexedBufReader<R>

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<R: Read + Unpin + Seek + Send> IndexableFile for IndexedBufReader<R>

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

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

fn read_current_line(
    &mut self,
    out_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.

impl<R: Read + Unpin + Seek + Send> ReadByLine for IndexedBufReader<R>

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