Struct tantivy::Segment

pub struct Segment { /* fields omitted */ }

A segment is a piece of the index.

Methods

impl Segment

fn schema(&self) -> Schema

Returns our index's schema.

fn id(&self) -> SegmentId

Returns the segment's id.

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 to a segment component.

fn delete(&self)

Deletes all of the document of the segment. This is called when there is a merge or a rollback.

Disclaimer

If deletion of a file fails (e.g. a file was read-only.), the method does not fail and just logs an error

fn open_read(&self,
             component: SegmentComponent)
             -> Result<ReadOnlySource, FileError>

Open one of the component file for read.

fn open_write(&mut self,
              component: SegmentComponent)
              -> Result<WritePtr, OpenWriteError>

Open one of the component file for write.

Trait Implementations

impl Clone for Segment

fn clone(&self) -> Segment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Segment

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

Formats the value using the given formatter.