Struct grenad::Reader

pub struct Reader<R> { /* private fields */ }

A struct that is able to read a grenad file that has been created by a crate::Writer.

Implementations

impl<R: Read + Seek> Reader<R>

pub fn new(reader: R) -> Result<Reader<R>, Error>

Creates a Reader that will read from the provided io::Read type.

pub fn into_cursor(self) -> Result<ReaderCursor<R>, Error>

Converts this Reader into a ReaderCursor.

pub fn into_prefix_iter(self, prefix: Vec<u8>) -> Result<PrefixIter<R>, Error>

Converts this Reader into a PrefixIter.

pub fn into_rev_prefix_iter( self, prefix: Vec<u8> ) -> Result<RevPrefixIter<R>, Error>

Converts this Reader into a RevPrefixIter.

pub fn into_range_iter<S, A>(self, range: S) -> Result<RangeIter<R>, Error>

where S: RangeBounds<A>, A: AsRef<[u8]>,

Converts this Reader into a RangeIter.

pub fn into_rev_range_iter<S, A>( self, range: S ) -> Result<RevRangeIter<R>, Error>

where S: RangeBounds<A>, A: AsRef<[u8]>,

Converts this Reader into a RevRangeIter.

impl<R> Reader<R>

pub fn file_version(&self) -> FileVersion

Returns the version of this file.

pub fn compression_type(&self) -> CompressionType

Returns the compression type of this file.

pub fn len(&self) -> u64

Returns the number of entries in this file.

pub fn is_empty(&self) -> bool

Returns weither this file contains entries or is empty.

pub fn into_inner(self) -> R

Consumes the Reader and returns the underlying io::Read type.

The returned io::Read type has been io::Seeked which means that you must seek it back to the front to read it from the start.

pub fn get_ref(&self) -> &R

Gets a reference to the underlying reader.

Trait Implementations

impl<R: Clone> Clone for Reader<R>

fn clone(&self) -> Reader<R>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.