[][src]Struct tantivy::Segment

pub struct Segment { /* fields omitted */ }

A segment is a piece of the index.


impl Segment[src]

pub fn index(&self) -> &Index[src]

Returns the index the segment belongs to.

pub fn schema(&self) -> Schema[src]

Returns our index's schema.

pub fn meta(&self) -> &SegmentMeta[src]

Returns the segment meta-information

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

Returns the segment's id.

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 open_read(
    component: SegmentComponent
) -> Result<ReadOnlySource, OpenReadError>

Open one of the component file for a regular read.

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

Open one of the component file for regular write.

Trait Implementations

impl Clone for Segment[src]

impl Debug for Segment[src]

Auto Trait Implementations

impl Send for Segment

impl Sync for Segment

impl Unpin for Segment

impl !UnwindSafe for Segment

impl !RefUnwindSafe for Segment

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