Struct Postings 

pub struct Postings { /* private fields */ }

A posting list held in RAM: elements sorted by record id, unique ids, every element carrying its tail_max ceiling (see the module docs).

Implementations

impl Postings

pub fn new() -> Self

An empty list.

pub fn from_pairs<I>(pairs: I) -> Self

where I: IntoIterator<Item = (RecordId, Weight)>,

Build from (id, weight) pairs in any order. Later pairs win over earlier ones with the same id.

pub fn from_sorted_pairs(pairs: &[(RecordId, Weight)]) -> Self

Build from pairs already sorted by strictly increasing id. Panics in debug builds if the order is violated.

pub fn as_slice(&self) -> &[Posting]

The elements, sorted by id.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn cursor(&self) -> SliceCursor<'_>

A cursor at the start of the list.

pub fn get(&self, id: RecordId) -> Option<Weight>

Weight of id, if present.

pub fn upsert(&mut self, id: RecordId, weight: Weight) -> Option<Weight>

Insert id with weight, or replace its weight if it is already present. Returns the previous weight when replacing.

Appending an id above every existing one costs O(1) unless the new weight raises existing ceilings, and then only the raised prefix is rewritten: inserting a corpus in id order is amortised O(1) per element for weights without a rising trend.

pub fn delete(&mut self, id: RecordId) -> Option<Weight>

Remove id. Returns its weight if it was present.

pub fn recompute_tail_max(&mut self)

Recompute every ceiling from scratch (after bulk edits through items_mut).

pub fn items_mut(&mut self) -> &mut Vec<Posting>

Mutable access to the raw elements for bulk edits. The caller must keep ids sorted and unique, and call recompute_tail_max afterwards.

pub fn check_invariants(&self) -> Result<(), String>

Check the structural invariants: ids strictly increasing, and every tail_max equal to the maximum weight of its inclusive suffix. Returns a description of the first violation.

Trait Implementations

impl Clone for Postings

fn clone(&self) -> Postings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Postings

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

Formats the value using the given formatter.

impl Default for Postings

fn default() -> Postings

Returns the “default value” for a type.

impl PartialEq for Postings

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Postings