Struct BlockIterator 

pub struct BlockIterator {
    block: BlockHolder,
    restart_point_index: usize,
    offset: usize,
    key: BytesMut,
    value_range: Range<usize>,
    entry_len: usize,
    last_key_len_type: LenType,
    last_value_len_type: LenType,
    hitmap: LocalHitmap<{ Block::HITMAP_ELEMS }>,
}

BlockIterator is used to read kv pairs in a block.

Fields

block: BlockHolder

Block that iterates on.

restart_point_index: usize

Current restart point index.

offset: usize

Current offset.

key: BytesMut

Current key.

value_range: Range<usize>

Current value.

entry_len: usize

Current entry len.

last_key_len_type: LenType

last_value_len_type: LenType

hitmap: LocalHitmap<{ Block::HITMAP_ELEMS }>

NOTE:

• hitmap is supposed to be updated each time accessing the block data in a new position.
• hitmap must be reported to the block hitmap before drop.

Implementations

impl BlockIterator

pub fn new(block: BlockHolder) -> Self

pub fn next(&mut self)

pub fn try_next(&mut self) -> bool

pub fn prev(&mut self)

pub fn try_prev(&mut self) -> bool

pub fn table_id(&self) -> TableId

pub fn key(&self) -> FullKey<&[u8]>

pub fn value(&self) -> &[u8]

pub fn is_valid(&self) -> bool

pub fn seek_to_first(&mut self)

pub fn seek_to_last(&mut self)

pub fn seek(&mut self, key: FullKey<&[u8]>)

pub fn seek_le(&mut self, key: FullKey<&[u8]>)

impl BlockIterator

fn invalidate(&mut self)

Invalidates current state after reaching a invalid state.

fn next_inner(&mut self)

Moving to the next entry

Note: The current state may be invalid if there is no more data to read

fn try_next_inner(&mut self) -> bool

Try moving to the next entry.

The current state will still be valid if there is no more data to read.

Return: true is the iterator is advanced and false otherwise.

fn next_until_key(&mut self, key: FullKey<&[u8]>)

Moves forward until reaching the first that equals or larger than the given key.

fn prev_until_key(&mut self, key: FullKey<&[u8]>)

Moves backward until reaching the first key that equals or smaller than the given key.

fn next_until_prev_offset(&mut self, offset: usize)

Moves forward until the position reaches the previous position of the given next_offset or the last valid position if exists.

fn prev_inner(&mut self)

Moving to the previous entry

Note: The current state may be invalid if there is no more data to read

fn try_prev_inner(&mut self) -> bool

Try moving to the previous entry.

The current state will still be valid if there is no more data to read.

Return: true is the iterator is advanced and false otherwise.

fn decode_prefix_at( &self, offset: usize, key_len_type: LenType, value_len_type: LenType, ) -> KeyPrefix

Decodes KeyPrefix at given offset.

fn search_restart_point_index_by_key(&mut self, key: FullKey<&[u8]>) -> usize

Searches the restart point index that the given key belongs to.

fn seek_restart_point_by_key(&mut self, key: FullKey<&[u8]>)

Seeks to the restart point that the given key belongs to.

fn seek_restart_point_by_index(&mut self, index: usize)

Seeks to the restart point by given restart point index.

fn update_restart_point(&mut self, index: usize)

Trait Implementations

impl Drop for BlockIterator

fn drop(&mut self)

Executes the destructor for this type.