Struct tantivy::SegmentReader

source · [−]

pub struct SegmentReader { /* private fields */ }

Expand description

Entry point to access all of the datastructures of the Segment

term dictionary
postings
store
fast field readers
field norm reader

The segment reader has a very low memory footprint, as close to all of the memory data is mmapped.

Implementations

source

impl SegmentReader

source

pub fn max_doc(&self) -> DocId

Returns the highest document id ever attributed in this segment + 1.

source

pub fn num_docs(&self) -> DocId

Returns the number of alive documents. Deleted documents are not counted.

source

pub fn schema(&self) -> &Schema

Returns the schema of the index this segment belongs to.

source

pub fn num_deleted_docs(&self) -> DocId

Return the number of documents that have been deleted in the segment.

source

pub fn has_deletes(&self) -> bool

Returns true if some of the documents of the segment have been deleted.

source

pub fn fast_fields(&self) -> &FastFieldReaders

Accessor to a segment’s fast field reader given a field.

Returns the u64 fast value reader if the field is a u64 field indexed as “fast”.

Return a FastFieldNotAvailableError if the field is not declared as a fast field in the schema.

Panics

May panic if the index is corrupted.

Accessor to the FacetReader associated to a given Field.

source

pub fn get_fieldnorms_reader(&self, field: Field) -> Result<FieldNormReader>

Accessor to the segment’s Field norms’s reader.

Field norms are the length (in tokens) of the fields. It is used in the computation of the TfIdf.

They are simply stored as a fast field, serialized in the .fieldnorm file of the segment.

source

pub fn get_store_reader(&self) -> Result<StoreReader>

Accessor to the segment’s StoreReader.

source

pub fn open(segment: &Segment) -> Result<SegmentReader>

Open a new segment for reading.

source

pub fn open_with_custom_alive_set(
segment: &Segment,
custom_bitset: Option<AliveBitSet>
) -> Result<SegmentReader>

Open a new segment for reading.

source

pub fn inverted_index(&self, field: Field) -> Result<Arc<InvertedIndexReader>>

Returns a field reader associated to the field given in argument. If the field was not present in the index during indexing time, the InvertedIndexReader is empty.

The field reader is in charge of iterating through the term dictionary associated to a specific field, and opening the posting list associated to any term.

If the field is marked as index, a warn is logged and an empty InvertedIndexReader is returned. Similarly if the field is marked as indexed but no term has been indexed for the given index. an empty InvertedIndexReader is returned (but no warning is logged).

source

pub fn segment_id(&self) -> SegmentId

Returns the segment id

source

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

Returns the delete opstamp

source

pub fn alive_bitset(&self) -> Option<&AliveBitSet>

Returns the bitset representing the documents that have been deleted.

source

pub fn is_deleted(&self, doc: DocId) -> bool

Returns true if the doc is marked as deleted.

source

pub fn doc_ids_alive(&self) -> Box<dyn Iterator<Item = DocId>>

Returns an iterator that will iterate over the alive document ids

source

pub fn space_usage(&self) -> Result<SegmentSpaceUsage>

Summarize total space usage of this segment.

Trait Implementations

source

impl Clone for SegmentReader

source

fn clone(&self) -> SegmentReader

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for SegmentReader

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl !RefUnwindSafe for SegmentReader

impl Send for SegmentReader

impl Sync for SegmentReader

impl Unpin for SegmentReader

impl !UnwindSafe for SegmentReader

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> Downcast for T where
T: Any,

source

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

source

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

source

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

source

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

source

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

source

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

Struct tantivy::SegmentReader

Implementations

impl SegmentReader

pub fn max_doc(&self) -> DocId

pub fn num_docs(&self) -> DocId

pub fn schema(&self) -> &Schema

pub fn num_deleted_docs(&self) -> DocId

pub fn has_deletes(&self) -> bool

pub fn fast_fields(&self) -> &FastFieldReaders

Panics

pub fn facet_reader(&self, field: Field) -> Result<FacetReader>

pub fn get_fieldnorms_reader(&self, field: Field) -> Result<FieldNormReader>

pub fn get_store_reader(&self) -> Result<StoreReader>

pub fn open(segment: &Segment) -> Result<SegmentReader>

pub fn open_with_custom_alive_set( segment: &Segment, custom_bitset: Option<AliveBitSet>) -> Result<SegmentReader>

pub fn inverted_index(&self, field: Field) -> Result<Arc<InvertedIndexReader>>

pub fn segment_id(&self) -> SegmentId

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

pub fn alive_bitset(&self) -> Option<&AliveBitSet>

pub fn is_deleted(&self, doc: DocId) -> bool

pub fn doc_ids_alive(&self) -> Box<dyn Iterator<Item = DocId>>

pub fn space_usage(&self) -> Result<SegmentSpaceUsage>

Trait Implementations

impl Clone for SegmentReader

fn clone(&self) -> SegmentReader

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

impl Debug for SegmentReader

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

Auto Trait Implementations

impl !RefUnwindSafe for SegmentReader

impl Send for SegmentReader

impl Sync for SegmentReader

impl Unpin for SegmentReader

impl !UnwindSafe for SegmentReader

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

fn borrow_mut(&mut self) -> &mut T

impl<T> Downcast for T where T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

fn as_any(&self) -> &(dyn Any + 'static)

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

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

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

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

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

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

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

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

pub fn open_with_custom_alive_set(
segment: &Segment,
custom_bitset: Option<AliveBitSet>
) -> Result<SegmentReader>

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

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

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

impl<T> Downcast for T where
T: Any,

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

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

impl<T> ToOwned for T where
T: Clone,

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

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

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