[][src]Struct tantivy::SegmentMeta

pub struct SegmentMeta { /* fields omitted */ }

SegmentMeta contains simple meta information about a segment.

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


impl SegmentMeta[src]

pub fn id(&self) -> SegmentId[src]

Returns the segment id.

pub fn num_deleted_docs(&self) -> u32[src]

Returns the number of deleted documents.

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

Returns the list of files that are required for the segment meta.

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[src]

Returns the relative path of a component of our segment.

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

pub fn max_doc(&self) -> u32[src]

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[src]

Return the number of documents in the segment.

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

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

pub fn has_deletes(&self) -> bool[src]

Returns true iff the segment meta contains delete information.

Trait Implementations

impl From<TrackedObject<InnerSegmentMeta>> for SegmentMeta[src]

impl Clone for SegmentMeta[src]

impl Debug for SegmentMeta[src]

impl Serialize for SegmentMeta[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Fruit for T where
    T: Send + Downcast

impl<T, U> Into<U> for T where
    U: From<T>, 

impl<T> From<T> for T[src]

impl<T> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

impl<T> Any for T where
    T: 'static + ?Sized

impl<T> Erased for T[src]

impl<T> Downcast for T where
    T: Any

impl<T> DowncastSync for T where
    T: Send + Sync + Any