Struct dbn::decode::DynDecoder

pub struct DynDecoder<'a, R>(/* private fields */)
where
    R: BufRead;

A decoder implementing DecodeDbn whose Encoding and Compression are determined at runtime by peeking at the first few bytes.

Implementations

impl<'a, R> DynDecoder<'a, BufReader<R>>where R: Read,

pub fn new( reader: R, compression: Compression, upgrade_policy: VersionUpgradePolicy ) -> Result<Self>

Creates a new DynDecoder from a reader, with the specified compression. It will decode records from previous DBN versions according to upgrade_policy.

Errors

This function will return an error if it fails to parse the metadata.

pub fn new_inferred( reader: R, upgrade_policy: VersionUpgradePolicy ) -> Result<Self>

Creates a new DynDecoder from a reader, inferring the encoding and compression. If reader also implements io::BufRead, it is better to use inferred_with_buffer(). It will decode records from previous DBN versions according to upgrade_policy.

Errors

This function will return an error if it is unable to determine the encoding of reader or it fails to parse the metadata.

impl<'a, R> DynDecoder<'a, R>where R: BufRead,

pub fn with_buffer( reader: R, compression: Compression, upgrade_policy: VersionUpgradePolicy ) -> Result<Self>

Creates a new DynDecoder from a buffered reader with the specified compression.It will decode records from previous DBN versions according to upgrade_policy.

Errors

This function will return an error if it is unable to determine the encoding of reader or it fails to parse the metadata.

pub fn inferred_with_buffer( reader: R, upgrade_policy: VersionUpgradePolicy ) -> Result<Self>

Creates a new DynDecoder from a buffered reader, inferring the encoding and compression.It will decode records from previous DBN versions according to upgrade_policy.

Errors

This function will return an error if it is unable to determine the encoding of reader or it fails to parse the metadata.

impl<'a> DynDecoder<'a, BufReader<File>>

pub fn from_file( path: impl AsRef<Path>, upgrade_policy: VersionUpgradePolicy ) -> Result<Self>

Creates a new DynDecoder from the file at path. It will decode records from previous DBN versions according to upgrade_policy.

Errors

This function will return an error if the file doesn’t exist, it is unable to determine the encoding of the file or it fails to parse the metadata.

Trait Implementations

impl<'a, R> DecodeDbn for DynDecoder<'a, R>where R: BufRead,

fn metadata(&self) -> &Metadata

Returns a reference to the decoded Metadata.

fn decode_record<T: HasRType>(&mut self) -> Result<Option<&T>>

Tries to decode a reference to a single record of type T. Returns Ok(None) if the input has been exhausted.

fn decode_stream<T: HasRType>(self) -> StreamIterDecoder<Self, T>where Self: Sized,

Converts the decoder into a streaming iterator of records of type T. This lazily decodes the data.

fn decode_records<T: HasRType + Clone>(self) -> Result<Vec<T>>where Self: Sized,

Tries to decode all records into a Vec. This eagerly decodes the data.

impl<'a, R> DecodeRecordRef for DynDecoder<'a, R>where R: BufRead,

fn decode_record_ref(&mut self) -> Result<Option<RecordRef<'_>>>

Tries to decode a generic reference a record. Returns Ok(None) if input has been exhausted.