Struct tantivy::postings::BlockSegmentPostings

source · [−]

pub struct BlockSegmentPostings { /* private fields */ }

Expand description

BlockSegmentPostings is a cursor iterating over blocks of documents.

Warning

While it is useful for some very specific high-performance use cases, you should prefer using SegmentPostings for most usage.

Implementations

source

impl BlockSegmentPostings

source

pub fn block_max_score(
    &mut self,
    fieldnorm_reader: &FieldNormReader,
    bm25_weight: &Bm25Weight
) -> Score

Returns the block_max_score for the current block. It does not require the block to be loaded. For instance, it is ok to call this method after having called .shallow_advance(..).

See TermScorer::block_max_score(..) for more information.

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.

This doc_freq is simply the sum of the length of all of the blocks length, and it does not take in account deleted documents.

source

pub fn docs(&self) -> &[DocId ]

Returns the array of docs in the current block.

Before the first call to .advance(), the block returned by .docs() is empty.

source

pub fn doc(&self, idx: usize) -> u32

Return the document at index idx of the block.

source

pub fn freqs(&self) -> &[u32 ]

Return the array of term freq in the block.

source

pub fn freq(&self, idx: usize) -> u32

Return the frequency at index idx of the block.

source

pub fn block_len(&self) -> usize

Returns the length of the current block.

All blocks have a length of NUM_DOCS_PER_BLOCK, except the last block that may have a length of any number between 1 and NUM_DOCS_PER_BLOCK - 1

source

pub fn seek(&mut self, target_doc: DocId)

Position on a block that may contains target_doc.

If all docs are smaller than target, the block loaded may be empty, or be the last an incomplete VInt block.

source

pub fn advance(&mut self)

Advance to the next block.

Returns false if and only if there is no remaining block.

source

pub fn empty() -> BlockSegmentPostings

Returns an empty segment postings object

Trait Implementations

source

impl Clone for BlockSegmentPostings

source

fn clone(&self) -> BlockSegmentPostings

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

Auto Trait Implementations

impl !RefUnwindSafe for BlockSegmentPostings

impl Send for BlockSegmentPostings

impl Sync for BlockSegmentPostings

impl Unpin for BlockSegmentPostings

impl !UnwindSafe for BlockSegmentPostings

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::BlockSegmentPostings

Warning

Implementations

impl BlockSegmentPostings

pub fn block_max_score( &mut self, fieldnorm_reader: &FieldNormReader, bm25_weight: &Bm25Weight) -> Score

pub fn doc_freq(&self) -> u32

pub fn docs(&self) -> &[DocId]

pub fn doc(&self, idx: usize) -> u32

pub fn freqs(&self) -> &[u32]

pub fn freq(&self, idx: usize) -> u32

pub fn block_len(&self) -> usize

pub fn seek(&mut self, target_doc: DocId)

pub fn advance(&mut self)

pub fn empty() -> BlockSegmentPostings

Trait Implementations

impl Clone for BlockSegmentPostings

fn clone(&self) -> BlockSegmentPostings

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

Auto Trait Implementations

impl !RefUnwindSafe for BlockSegmentPostings

impl Send for BlockSegmentPostings

impl Sync for BlockSegmentPostings

impl Unpin for BlockSegmentPostings

impl !UnwindSafe for BlockSegmentPostings

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 block_max_score(
&mut self,
fieldnorm_reader: &FieldNormReader,
bm25_weight: &Bm25Weight
) -> Score

pub fn docs(&self) -> &[DocId ]

pub fn freqs(&self) -> &[u32 ]

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,