Struct sonnerie::key_reader::Reader

pub struct Reader { /* fields omitted */ }

Read and filter keys from a single transaction file

Implementations

impl Reader

pub fn new(r: File) -> Result<Reader>

Open a single transaction file

If instead you want to read from an entire database, use DatabaseReader which provides a similar API.

pub fn get<'rdr, 'k>(
    &'rdr self,
    key: &'k str
) -> StringKeyRangeReader<'rdr, 'k, RangeInclusive<&'k str>>

Get a reader for only a single key

Returns an object that will read all of the records for only one key.

pub fn get_range<'rdr, 'k, RB>(
    &'rdr self,
    range: RB
) -> StringKeyRangeReader<'rdr, 'k, RB> where
    RB: RangeBounds<&'k str>, 

Get a reader for a lexicographic range of keys

Use inclusive or exclusive range syntax to select a range.

Example: rdr.get_range("chimpan-ay" ..= "chimpan-zee")

Range queries are always efficient and readahead may occur.

pub fn get_filter<'rdr, 'k>(
    &'rdr self,
    wildcard: &'k Wildcard
) -> StringKeyRangeReader<'rdr, 'k, RangeFrom<&'k str>>

Get a reader that filters on SQL's "LIKE"-like syntax.

A wildcard filter that has a fixed prefix, such as "chimp%" is always efficient.

pub fn print_info<W: Write>(&self, w: &mut W) -> Result<()>

Print diagnostic information about this transaction file.

This function is for debugging only.