Struct Decoder

pub struct Decoder<R: BufRead> { /* private fields */ }

👎Deprecated since 0.3.0: DBZ was renamed to DBN and the format was changed to no longer rely on Zstd.

Object for reading, parsing, and serializing a legacy Databento Binary Encoding (DBZ) file.

Implementations

impl Decoder<BufReader<File>>

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

👎Deprecated since 0.3.0: DBZ was renamed to DBN and the format was changed to no longer rely on Zstd.

Creates a new Decoder from the file at path. This function reads the metadata, but does not read the body of the file.

Errors

This function will return an error if path doesn’t exist. It will also return an error if it is unable to parse the metadata from the file.

impl<R: BufRead> Decoder<R>

pub fn new(reader: R) -> Result<Self>

👎Deprecated since 0.3.0: DBZ was renamed to DBN and the format was changed to no longer rely on Zstd.

Creates a new DBZ Decoder from reader. Will upgrade records from previous versions to the current version.

Errors

This function will return an error if it is unable to parse the metadata in reader.

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

👎Deprecated since 0.3.0: DBZ was renamed to DBN and the format was changed to no longer rely on Zstd.

Creates a new DBZ Decoder from reader. It will decode records from according to upgrade_policy.

Errors

This function will return an error if it is unable to parse the metadata in `reader.

Trait Implementations

impl<R: BufRead> DbnMetadata for Decoder<R>

fn metadata(&self) -> &Metadata

Returns an immutable reference to the decoded Metadata.

fn metadata_mut(&mut self) -> &mut Metadata

Returns a mutable reference to the decoded Metadata.

impl<R: BufRead> DecodeRecord for Decoder<R>

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_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<R: BufRead> DecodeRecordRef for Decoder<R>

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.

impl<R: BufRead> DecodeStream for Decoder<R>

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

where Self: Sized,

Try to decode the DBZ file into a streaming iterator. This decodes the data lazily.

Errors

This function will return an error if the zstd portion of the DBZ file was compressed in an unexpected manner.