Struct Dbz

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

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

Implementations

impl Dbz<BufReader<File>>

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

Creates a new Dbz 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> Dbz<R>

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

Creates a new Dbz from reader.

Errors

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

pub fn schema(&self) -> Schema

Returns the Schema of the DBZ data. The schema also indicates the record type T for Self::try_into_iter.

pub fn metadata(&self) -> &Metadata

Returns a reference to all metadata read from the Dbz data in a Metadata object.

pub fn try_into_iter<T: ConstTypeId>(self) -> Result<DbzStreamIter<R, T>>

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.

impl<R: BufRead> Dbz<R>

pub fn write_to( self, writer: impl Write, encoding: OutputEncoding, ) -> Result<()>

Streams the contents of the Dbz to writer encoding it using encoding. Consumes the Dbz object.

Errors

This function returns an error if Dbz::schema() is Schema::Statistics. It will also return an error if there’s an issue writing the output to writer.

Trait Implementations

impl<R: Debug + BufRead> Debug for Dbz<R>

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

Formats the value using the given formatter.