Struct PostingList 

pub struct PostingList { /* private fields */ }

An in-memory posting list for one term.

Implementations

impl PostingList

pub const fn new() -> Self

Creates an empty list.

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

Returns the postings, ascending by document id.

pub fn document_frequency(&self) -> u32

Returns the number of documents containing the term.

pub fn is_empty(&self) -> bool

Returns true when no document contains the term.

pub fn push(&mut self, posting: Posting) -> Result<(), PostingsError>

Appends one posting.

Errors

Returns PostingsError when document ids are not strictly ascending, when positions are not strictly ascending, or when the term frequency is zero. These are contract violations by the caller, so they fail loudly rather than being repaired.

Trait Implementations

impl Clone for PostingList

fn clone(&self) -> Self

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() -> Self

Returns the “default value” for a type.

impl Eq for PostingList

impl PartialEq for PostingList

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PostingList