Struct tantivy::postings::SegmentPostings

source · [−]

pub struct SegmentPostings { /* private fields */ }

Expand description

SegmentPostings represents the inverted list or postings associated to a term in a Segment.

As we iterate through the SegmentPostings, the frequencies are optionally decoded. Positions on the other hand, are optionally entirely decoded upfront.

Implementations

source

impl SegmentPostings

source

pub fn empty() -> Self

Returns an empty segment postings object

source

pub fn doc_freq_given_deletes(&self, alive_bitset: &AliveBitSet) -> u32

Compute the number of non-deleted documents.

This method will clone and scan through the posting lists. (this is a rather expensive operation).

source

pub fn doc_freq(&self) -> u32

Returns the overall number of documents in the block postings. It does not take in account whether documents are deleted or not.

Trait Implementations

source

impl Clone for SegmentPostings

source

fn clone(&self) -> SegmentPostings

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 DocSet for SegmentPostings

source

fn doc(&self) -> DocId

Return the current document’s DocId.

source

fn advance(&mut self) -> DocId

Goes to the next element. Read more

source

fn seek(&mut self, target: DocId) -> DocId

Advances the DocSet forward until reaching the target, or going to the lowest DocId greater than the target. Read more

source

fn size_hint(&self) -> u32

Returns a best-effort hint of the length of the docset. Read more

source

fn fill_buffer(&mut self, buffer: &mut [DocId ]) -> usize

Fills a given mutable buffer with the next doc ids from the DocSet Read more

source

fn count(&mut self, alive_bitset: &AliveBitSet) -> u32

Returns the number documents matching. Calling this method consumes the DocSet. Read more

source

fn count_including_deleted(&mut self) -> u32

Returns the count of documents, deleted or not. Calling this method consumes the DocSet. Read more

source

impl HasLen for SegmentPostings

source

fn len(&self) -> usize

Return length

source

fn is_empty(&self) -> bool

Returns true iff empty.

source

impl Postings for SegmentPostings

source

fn term_freq(&self) -> u32

Returns the frequency associated to the current document. If the schema is set up so that no frequency have been encoded, this method should always return 1.

Panics

Will panics if called without having called advance before.

source

fn positions_with_offset(&mut self, offset: u32, output: &mut Vec<u32>)

Returns the positions offseted with a given value. The output vector will be resized to the term_freq. Read more

source

fn positions(&mut self, output: &mut Vec<u32>)

Returns the positions of the term in the given document. The output vector will be resized to the term_freq. Read more

Auto Trait Implementations

impl !RefUnwindSafe for SegmentPostings

impl Send for SegmentPostings

impl Sync for SegmentPostings

impl Unpin for SegmentPostings

impl !UnwindSafe for SegmentPostings

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::postings::SegmentPostings

Implementations

impl SegmentPostings

pub fn empty() -> Self

pub fn doc_freq_given_deletes(&self, alive_bitset: &AliveBitSet) -> u32

pub fn doc_freq(&self) -> u32

Trait Implementations

impl Clone for SegmentPostings

fn clone(&self) -> SegmentPostings

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

impl DocSet for SegmentPostings

fn doc(&self) -> DocId

fn advance(&mut self) -> DocId

fn seek(&mut self, target: DocId) -> DocId

fn size_hint(&self) -> u32

fn fill_buffer(&mut self, buffer: &mut [DocId]) -> usize

fn count(&mut self, alive_bitset: &AliveBitSet) -> u32

fn count_including_deleted(&mut self) -> u32

impl HasLen for SegmentPostings

fn len(&self) -> usize

fn is_empty(&self) -> bool

impl Postings for SegmentPostings

fn term_freq(&self) -> u32

Panics

fn positions_with_offset(&mut self, offset: u32, output: &mut Vec<u32>)

fn positions(&mut self, output: &mut Vec<u32>)

Auto Trait Implementations

impl !RefUnwindSafe for SegmentPostings

impl Send for SegmentPostings

impl Sync for SegmentPostings

impl Unpin for SegmentPostings

impl !UnwindSafe for SegmentPostings

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,

fn fill_buffer(&mut self, buffer: &mut [DocId ]) -> usize

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,