Struct lance_core::format::pb::Manifest

pub struct Manifest {
    pub fields: Vec<Field>,
    pub fragments: Vec<DataFragment>,
    pub version: u64,
    pub version_aux_data: u64,
    pub metadata: HashMap<String, Vec<u8>>,
    pub index_section: Option<u64>,
    pub timestamp: Option<Timestamp>,
    pub tag: String,
    pub reader_feature_flags: u64,
    pub writer_feature_flags: u64,
    pub max_fragment_id: u32,
    pub transaction_file: String,
}

Manifest is a global section shared between all the files.

Fields

fields: Vec<Field>

All fields of the dataset, including the nested fields.

fragments: Vec<DataFragment>

Fragments of the dataset.

version: u64

Snapshot version number.

version_aux_data: u64

The file position of the version auxiliary data.

• It is not inheritable between versions.
• It is not loaded by default during query.

metadata: HashMap<String, Vec<u8>>

Schema metadata.

index_section: Option<u64>

If presented, the file position of the index metadata.

timestamp: Option<Timestamp>

Version creation Timestamp, UTC timezone

tag: String

Optional version tag

reader_feature_flags: u64

Feature flags for readers.

A bitmap of flags that indicate which features are required to be able to read the table. If a reader does not recognize a flag that is set, it should not attempt to read the dataset.

Known flags:

• 1: deletion files are present

writer_feature_flags: u64

Feature flags for writers.

A bitmap of flags that indicate which features are required to be able to write to the dataset. if a writer does not recognize a flag that is set, it should not attempt to write to the dataset.

The flags are the same as for reader_feature_flags, although they will not always apply to both.

max_fragment_id: u32

The highest fragment ID that has been used so far.

This ID is not guaranteed to be present in the current version, but it may have been used in previous versions.

For a single file, will be zero.

transaction_file: String

Path to the transaction file, relative to {root}/_transactions

This contains a serialized Transaction message representing the transaction that created this version.

May be empty if no transaction file was written.

The path format is “{read_version}-{uuid}.txn” where {read_version} is the version of the table the transaction read from, and {uuid} is a hyphen-separated UUID.

Implementations

impl Manifest

pub fn index_section(&self) -> u64

Returns the value of index_section, or the default value if index_section is unset.

Trait Implementations

impl Clone for Manifest

fn clone(&self) -> Manifest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Manifest

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

Formats the value using the given formatter.

impl Default for Manifest

fn default() -> Self

Returns the “default value” for a type.

impl From<&Manifest> for Manifest

fn from(m: &Manifest) -> Self

Converts to this type from the input type.

impl From<Manifest> for Manifest

fn from(p: Manifest) -> Self

Converts to this type from the input type.

impl Message for Manifest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Manifest

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Manifest