Struct tantivy::index::SegmentMeta

pub struct SegmentMeta { /* private fields */ }

SegmentMeta contains simple meta information about a segment.

For instance the number of docs it contains, how many are deleted, etc.

Implementations

impl SegmentMeta

pub fn id(&self) -> SegmentId

Returns the segment id.

pub fn untrack_temp_docstore(&self)

Removes the Component::TempStore from the alive list and therefore marks the temp docstore file to be deleted by the garbage collection.

pub fn num_deleted_docs(&self) -> u32

Returns the number of deleted documents.

pub fn list_files(&self) -> HashSet<PathBuf>

Returns the list of files that are required for the segment meta. Note: Some of the returned files may not exist depending on the state of the segment.

This is useful as the way tantivy removes files is by removing all files that have been created by tantivy and are not used by any segment anymore.

pub fn relative_path(&self, component: SegmentComponent) -> PathBuf

Returns the relative path of a component of our segment.

It just joins the segment id with the extension associated with a segment component.

pub fn max_doc(&self) -> u32

Return the highest doc id + 1

If there are no deletes, then num_docs = max_docs and all the doc ids contains in this segment are exactly (0..max_doc).

pub fn num_docs(&self) -> u32

Return the number of documents in the segment.

pub fn delete_opstamp(&self) -> Option<Opstamp>

Returns the Opstamp of the last delete operation taken in account in this segment.

pub fn has_deletes(&self) -> bool

Returns true iff the segment meta contains delete information.

Trait Implementations

impl Clone for SegmentMeta

fn clone(&self) -> SegmentMeta

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SegmentMeta

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

Formats the value using the given formatter.

impl From<TrackedObject<InnerSegmentMeta>> for SegmentMeta

fn from(tracked: TrackedObject<InnerSegmentMeta>) -> SegmentMeta

Converts to this type from the input type.

impl Serialize for SegmentMeta

fn serialize<S>( &self, serializer: S ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.