Struct indexed_file::File

pub struct File {
    pub inner_file: BufReader<File>,
    // some fields omitted
}

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

Fields

inner_file: BufReader<File>

Implementations

impl File

pub async 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 async fn open_raw<P: AsRef<Path>>(path: P) -> Result<File>

Opens a non indexed file and generates the index.

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

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

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

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

pub fn total_lines(&self) -> usize

Returns the total amount of lines of the file.

pub fn get_index(&self) -> &Index

Returns a reference to the files index.

Trait Implementations

impl Debug for File

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

Formats the value using the given formatter.

impl ReadByLine for File

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

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

fn seek<'life0, 'async_trait>(
    &'life0 mut self,
    pos: SeekFrom
) -> Pin<Box<dyn Future<Output = Result<u64>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Should seek to the reader used in read_to_eol to the given SeekFrom

fn read_to_eol<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    buf: &'life1 mut Vec<u8>
) -> Pin<Box<dyn Future<Output = Result<usize>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

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

fn read_line<'life0, 'async_trait>(
    &'life0 mut self,
    line: usize
) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: Send + 'async_trait, 

Reads the given line

fn read_line_raw<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    line: usize,
    buf: &'life1 mut Vec<u8>
) -> Pin<Box<dyn Future<Output = Result<usize>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: Send + 'async_trait, 

Reads the given line and stores into buf