Struct tantivy::IndexMeta

pub struct IndexMeta {
    pub index_settings: IndexSettings,
    pub segments: Vec<SegmentMeta>,
    pub schema: Schema,
    pub opstamp: Opstamp,
    pub payload: Option<String>,
}

Meta information about the Index.

This object is serialized on disk in the meta.json file. It keeps information about

• the searchable segments,
• the index docstamp
• the schema

Fields

index_settings: IndexSettings

IndexSettings to configure index options.

segments: Vec<SegmentMeta>

List of SegmentMeta information associated with each finalized segment of the index.

schema: Schema

Index Schema

opstamp: Opstamp

Opstamp associated with the last commit operation.

payload: Option<String>

Payload associated with the last commit.

Upon commit, clients can optionally add a small String payload to their commit to help identify this commit. This payload is entirely unused by tantivy.

Implementations

impl IndexMeta

pub fn with_schema(schema: Schema) -> IndexMeta

Create an IndexMeta object representing a brand new Index with the given index.

This new index does not contains any segments. Opstamp will the value 0u64.

Trait Implementations

impl Clone for IndexMeta

fn clone(&self) -> IndexMeta

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IndexMeta

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

Formats the value using the given formatter.

impl Serialize for IndexMeta

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

Serialize this value into the given Serde serializer.