Struct PostingList 

pub struct PostingList { /* private fields */ }

The locators stored under one index key. See the module docs for why this is not a Vec.

Implementations

impl PostingList

pub const fn new() -> Self

An empty list. Allocates nothing.

pub fn single(locator: RowLocator) -> Self

A list holding one locator — the shape every new index key starts in.

pub fn push(&mut self, locator: RowLocator)

Append one locator.

pub fn len(&self) -> usize

Number of locators.

pub fn is_empty(&self) -> bool

Whether the list holds no locators.

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

The locators in insertion order.

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

The locators in insertion order, by value.

pub fn first(&self) -> Option<RowLocator>

The first locator, if any.

pub fn last(&self) -> Option<RowLocator>

The last locator, if any.

pub fn contains(&self, locator: RowLocator) -> bool

Whether locator appears in the list.

pub fn retain(&mut self, keep: impl Fn(RowLocator) -> bool)

Keep only the locators keep accepts, rebuilding the blocks.

Rebuilds rather than edits in place: the frozen blocks are shared, so dropping from the middle of one would copy it anyway.

The common call drops nothing, and that case must not allocate — the insert path prunes a key’s dead versions every time its list reaches a power-of-two length. So the list is tested first and only rebuilt if something is actually going. keep therefore sees a retained locator TWICE, which is why it is Fn and not FnMut: a predicate here has to be pure.

pub fn to_vec(&self) -> Vec<RowLocator>

Collect into a flat Vec, for callers that need contiguity.

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 Eq for PostingList

impl From<Vec<RowLocator>> for PostingList

fn from(v: Vec<RowLocator>) -> Self

Converts to this type from the input type.

impl FromIterator<RowLocator> for PostingList

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

Creates a value from an iterator.

impl<'a> IntoIterator for &'a PostingList

type Item = &'a RowLocator

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = &'a RowLocator> + 'a>

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<const N: usize> PartialEq<[RowLocator; N]> for PostingList

fn eq(&self, other: &[RowLocator; N]) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<[RowLocator]> for PostingList

Compare against a flat sequence, so a caller holding an expected order does not have to know how the list is blocked internally.

fn eq(&self, other: &[RowLocator]) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PostingList