Struct dbn::encode::dbn::MetadataEncoder

pub struct MetadataEncoder<W>where
    W: Write,{ /* private fields */ }

Type for encoding Metadata into Databento Binary Encoding (DBN).

Implementations

impl<W> MetadataEncoder<W>where W: Write,

pub const MIN_ENCODED_SIZE: usize = 128usize

The minimum size in bytes of encoded metadata.

pub const START_OFFSET: usize = 26usize

The offset of start in encoded metadata.

pub fn new(writer: W) -> Self

Creates a new MetadataEncoder that will write to writer.

pub fn encode(&mut self, metadata: &Metadata) -> Result<()>

Encodes metadata into DBN.

Errors

This function returns an error if it fails to write to the underlying writer.

impl<W> MetadataEncoder<W>where W: Write + Seek,

pub fn update_encoded( &mut self, start: u64, end: Option<NonZeroU64>, limit: Option<NonZeroU64> ) -> Result<()>

Updates the given metadata properties in an existing DBN buffer.

Errors

This function returns an error if it’s unable to seek to the position to update the metadata or it fails to write to the underlying writer.