Skip to main content

BlockMeta

Struct BlockMeta 

Source
pub struct BlockMeta {
    pub last_docid: u32,
    pub docids_offset: u32,
    pub tfs_offset: u32,
    pub positions_offset: u32,
    pub positions_count: u32,
    pub count: u16,
    pub docid_bits: u8,
    pub tf_bits: u8,
    pub position_bits: u8,
    pub block_max: u8,
    pub max_tf: u32,
    pub min_len: u16,
}
Expand description

One block’s metadata row, exactly BLOCK_META_LEN bytes on disk.

Fields§

§last_docid: u32

Largest document id in the block; the skip key.

§docids_offset: u32

Byte offset of the block’s packed docid deltas.

§tfs_offset: u32

Byte offset of the block’s packed term frequencies.

§positions_offset: u32

Byte offset of the block’s packed positions.

§positions_count: u32

Packed positions in the block.

§count: u16

Postings in the block; the final block may be partial.

§docid_bits: u8

Bit width of the docid deltas.

§tf_bits: u8

Bit width of the term frequencies.

§position_bits: u8

Bit width of the position deltas.

§block_max: u8

Reserved for a caller-supplied impact. Written zero by this engine.

Version 1 stored quantize(score / ceiling) here and computed the pruning bound from it. That was unsound: the quotient bakes in seal-time avgdl and seal-time (k1, b), neither of which cancels, so the stored bound fell below a true score once statistics drifted. The slot is kept — its shape suits a caller-supplied learned impact — but nothing in the engine reads it for a bound.

§max_tf: u32

Largest term frequency in the block. Zero in a version 1 stream.

§min_len: u16

Smallest document length in the block, saturating DOWN to u16::MAX.

Down, because a shorter document scores higher: saturating upward would put the stored bound below a true score.

Implementations§

Source§

impl BlockMeta

Source

pub fn read(input: &[u8]) -> Result<Self, PostingsError>

Reads one metadata row from the front of input.

§Errors

Returns PostingsError::Truncated when fewer than BLOCK_META_LEN bytes are available.

Trait Implementations§

Source§

impl Clone for BlockMeta

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for BlockMeta

Source§

impl Debug for BlockMeta

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BlockMeta

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for BlockMeta

Source§

impl PartialEq for BlockMeta

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for BlockMeta

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.