Struct BlockPostingList 

pub struct BlockPostingList { /* private fields */ }

Implementations

impl BlockPostingList

pub fn from_posting_list(list: &PostingList) -> Result<Self>

Build from a posting list

pub fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

Serialize the block posting list (footer-based: data first).

Format:

[block data: data_len bytes]
[skip entries: N × 16 bytes (base_doc, last_doc, offset, block_max_tf)]
[footer: data_len(4) + skip_count(4) + doc_count(4) + max_tf(4) = 16 bytes]

pub fn deserialize(raw: &[u8]) -> Result<Self>

Deserialize from a byte slice (footer-based format).

pub fn doc_count(&self) -> u32

pub fn max_tf(&self) -> u32

Get maximum term frequency (for WAND upper bound computation)

pub fn num_blocks(&self) -> usize

Get number of blocks

pub fn block_info( &self, block_idx: usize, ) -> Option<(DocId, DocId, usize, usize, u32)>

Get block metadata: (base_doc_id, last_doc_id, data_offset, data_len, block_max_tf)

pub fn block_max_tf(&self, block_idx: usize) -> Option<u32>

Get block’s max term frequency for Block-Max WAND

pub fn block_data(&self, block_idx: usize) -> Option<&[u8]>

Get raw block data for direct copying during merge

pub fn concatenate_blocks(sources: &[(BlockPostingList, u32)]) -> Result<Self>

Concatenate blocks from multiple posting lists with doc_id remapping This is O(num_blocks) instead of O(num_postings)

pub fn concatenate_streaming<W: Write>( sources: &[(&[u8], u32)], writer: &mut W, ) -> Result<(u32, usize)>

Streaming merge: write blocks directly to output writer (bounded memory).

Parses only footer + skip_list from each source (no data copy), streams block data with patched 8-byte prefixes directly to writer, then appends merged skip_list + footer.

Memory per term: O(total_blocks × 16) for skip entries only. Block data flows source mmap → output writer without buffering.

Returns (doc_count, bytes_written).

pub fn iterator(&self) -> BlockPostingIterator<'_>

Create an iterator with skip support

pub fn into_iterator(self) -> BlockPostingIterator<'static>

Create an owned iterator that doesn’t borrow self

Trait Implementations

impl Clone for BlockPostingList

fn clone(&self) -> BlockPostingList

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BlockPostingList

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

Formats the value using the given formatter.