Struct Metadata

pub struct Metadata {

    pub version: u8,
    pub dataset: String,
    pub schema: Schema,
    pub start: u64,
    pub end: u64,
    pub limit: u64,
    pub record_count: u64,
    pub compression: Compression,
    pub stype_in: SType,
    pub stype_out: SType,
    pub symbols: Vec<String>,
    pub partial: Vec<String>,
    pub not_found: Vec<String>,
    pub mappings: Vec<SymbolMapping>,
}

Information about the data contained in a DBZ file.

Fields

version: u8

The DBZ schema version number.

dataset: String

The dataset name.

schema: Schema

The data record schema. Specifies which record type is stored in the DBZ file.

start: u64

The UNIX nanosecond timestamp of the query start, or the first record if the file was split.

end: u64

The UNIX nanosecond timestamp of the query end, or the last record if the file was split.

limit: u64

The maximum number of records for the query.

record_count: u64

The total number of data records.

compression: Compression

The data compression format (if any).

stype_in: SType

The input symbology type to map from.

stype_out: SType

The output symbology type to map to.

symbols: Vec<String>

The original query input symbols from the request.

partial: Vec<String>

Symbols that did not resolve for at least one day in the query time range.

not_found: Vec<String>

Symbols that did not resolve for any day in the query time range.

mappings: Vec<SymbolMapping>

Symbol mappings containing a native symbol and its mapping intervals.

Implementations

impl Metadata

pub fn encode(&self, writer: impl Write + Seek) -> Result<()>

pub fn update_encoded( writer: impl Write + Seek, start: u64, end: u64, limit: u64, record_count: u64, ) -> Result<()>

impl Metadata

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

Writes the metadata to writer encoding it using encoding, if supported.

Note

Encoding Metadata as CSV is unsupported.

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 Clone for Metadata

fn clone(&self) -> Metadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Metadata

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

Formats the value using the given formatter.

impl PartialEq for Metadata

fn eq(&self, other: &Metadata) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Metadata

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Metadata

impl StructuralPartialEq for Metadata