Skip to main content

Postings

Struct Postings 

Source
pub struct Postings { /* private fields */ }
Expand description

Inverted index: trigram_hash -> bitmap of doc ids.

Implementations§

Source§

impl Postings

Source

pub fn new() -> Self

Construct an empty postings index.

Source

pub fn len(&self) -> usize

Number of distinct trigrams present in the index.

Source

pub fn is_empty(&self) -> bool

Whether the index has any entries.

Source

pub fn insert(&mut self, trigram: u64, doc_id: u32)

Insert doc_id into the postings list for trigram.

Idempotent: re-inserting the same (trigram, doc_id) pair is a no-op.

Source

pub fn remove(&mut self, trigram: u64, doc_id: u32)

Remove doc_id from the postings list for trigram.

If removing leaves the postings list empty, the trigram entry is dropped from the map (garbage collection).

Source

pub fn lookup(&self, trigram: u64) -> Option<&RoaringBitmap>

Borrow the postings bitmap for trigram, if any.

Source

pub fn intersect(&self, trigrams: &[u64]) -> RoaringBitmap

Intersect the postings lists for the given trigrams.

Returns the set of doc ids that appear in EVERY trigram’s list. If trigrams is empty, the result is empty (the index does not invent a “universal” set: callers asking to intersect “no” trigrams should treat this as a no-evidence query and either fall back to a full scan or return the empty set, depending on policy).

If any trigram has no postings entry, the result is empty (a missing trigram is provably absent from every doc).

The reduction order is by ascending posting-list size so the working set shrinks as fast as possible.

Source

pub fn union(&self, trigrams: &[u64]) -> RoaringBitmap

Union the postings lists for the given trigrams.

Returns the set of doc ids that appear in AT LEAST ONE of the trigrams’ lists. Missing trigrams contribute nothing. An empty input yields the empty set.

Trait Implementations§

Source§

impl Clone for Postings

Source§

fn clone(&self) -> Postings

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Postings

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Postings

Source§

fn default() -> Postings

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Postings

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Postings

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

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,

Source§

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)

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,