Struct PostingList 

pub struct PostingList { /* private fields */ }

Ordered sequence of (doc_id, payload) pairs.

Invariant: entries is sorted by doc_id ascending and contains no duplicate doc_ids.

Implementations

impl PostingList

pub fn new() -> Self

Construct an empty posting list.

pub fn from_unsorted(entries: Vec<PostingEntry>) -> Self

Construct from possibly unsorted, possibly duplicated entries.

Sorts by doc_id ascending and keeps the first occurrence on duplicate doc_ids.

pub fn from_sorted_unchecked(entries: Vec<PostingEntry>) -> Self

Construct from entries that are already sorted by doc_id ascending and contain no duplicate doc_ids.

In debug builds this checks the invariant. In release builds it is O(1) — the caller is responsible for upholding the invariant. Used by internal merges that produce sorted output by construction.

pub fn merge_union(&self, other: &Self) -> Self

Keep the union of both supports and merge payloads on a shared doc_id.

This is not Boolean join on full posting values: scores add and fields from other take precedence on collision. Use Self::support when a Boolean-algebra value is required.

pub fn merge_intersection(&self, other: &Self) -> Self

Keep the intersection of both supports and merge payloads on each shared doc_id.

This is not Boolean meet on full posting values. Its payload policy is the same as Self::merge_union.

pub fn merge_intersection_owned(self, other: &Self) -> Self

Consuming intersection merge that avoids a result allocation for large inputs by reusing the left posting buffer. Small inputs retain the lower-overhead allocating path. Payload semantics are identical to PostingList::merge_intersection, including right-hand field precedence.

pub fn merge_support_intersection_owned(self, other: &Self) -> Self

Intersect document support and reconstruct every retained entry with a default payload. This is the physical meet for membership-only operator subtrees; unlike Self::merge_intersection_owned, it deliberately does not observe or combine scores, positions, or fields.

pub fn exclude(&self, other: &Self) -> Self

A - B: entries of A whose doc_id does not appear in B.

A membership filter preserves left payloads and the sorted invariant; the temporary BTreeSet provides deterministic O(log |B|) probes.

pub fn ranked(&self) -> RankedView<'_>

Build a score-ordered view without changing posting storage order.

pub fn with_scores<F>(&self, score_fn: F) -> Self

where F: Fn(&PostingEntry) -> f64,

Apply a scoring function to every entry, returning a new posting list.

pub fn get_entry(&self, doc_id: DocId) -> Option<&PostingEntry>

Look up an entry by doc_id. O(log n) via binary search.

pub fn entries(&self) -> &[PostingEntry]

pub fn doc_ids(&self) -> impl Iterator<Item = DocId> + '_

pub fn support(&self) -> DocSet

Project this payload-bearing relation onto its document-id support.

pub fn from_support(support: &DocSet) -> Self

Create document-id-ordered posting storage with a default payload for every id in support.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn iter(&self) -> Iter<'_, PostingEntry>

Trait Implementations

impl Clone for PostingList

fn clone(&self) -> PostingList

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PostingList

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

Formats the value using the given formatter.

impl Default for PostingList

fn default() -> PostingList

Returns the “default value” for a type.

impl From<&DocSet> for PostingList

fn from(support: &DocSet) -> Self

Converts to this type from the input type.

impl From<&PostingList> for DocSet

fn from(posting_list: &PostingList) -> Self

Converts to this type from the input type.

impl From<DocSet> for PostingList

fn from(support: DocSet) -> Self

Converts to this type from the input type.

impl FromIterator<PostingEntry> for PostingList

fn from_iter<I: IntoIterator<Item = PostingEntry>>(iter: I) -> Self

Creates a value from an iterator.

impl IntoIterator for PostingList

type Item = PostingEntry

The type of the elements being iterated over.

type IntoIter = IntoIter<PostingEntry>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a PostingList

type Item = &'a PostingEntry

The type of the elements being iterated over.

type IntoIter = Iter<'a, PostingEntry>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for PostingList

fn eq(&self, other: &PostingList) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for PostingList