Struct UserIterator

pub struct UserIterator<I: HummockIterator<Direction = Forward>> {
    iterator: I,
    full_key_tracker: FullKeyTracker<Vec<u8>, true>,
    key_range: UserKeyRange,
    read_epoch: HummockEpoch,
    min_epoch: HummockEpoch,
    _version: Option<PinnedVersion>,
    stats: StoreLocalStatistic,
    is_current_pos_valid: bool,
}

UserIterator can be used by user directly.

Fields

iterator: I

Inner table iterator.

full_key_tracker: FullKeyTracker<Vec<u8>, true>

key_range: UserKeyRange

Start and end bounds of user key.

read_epoch: HummockEpoch

Only reads values if ts <= self.read_epoch.

min_epoch: HummockEpoch

Only reads values if ts > self.min_epoch. use for ttl

_version: Option<PinnedVersion>

Ensures the SSTs needed by iterator won’t be vacuumed.

stats: StoreLocalStatistic

is_current_pos_valid: bool

Whether the iterator is pointing to a valid position

Implementations

impl<I: HummockIterator<Direction = Forward>> UserIterator<I>

pub(crate) fn new( iterator: I, key_range: UserKeyRange, read_epoch: u64, min_epoch: u64, version: Option<PinnedVersion>, ) -> Self

Create UserIterator with given read_epoch.

pub fn for_test(iterator: I, key_range: UserKeyRange) -> Self

Create UserIterator with maximum epoch.

pub async fn next(&mut self) -> HummockResult<()>

Gets the iterator move to the next step. See IteratorState for the state machine details.

Returned result:

• if Ok(()) is returned, it means that the iterator successfully move to the next position (may reach to the end and thus not valid)
• if Err(_) is returned, it means that some error happened.

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

Returns the key with the newest version. Thus no version in it, and only the user_key will be returned.

The returned key is de-duplicated and thus it will not output the same key, unless the rewind or seek methods are called.

Note: before call the function you need to ensure that the iterator is valid.

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

The returned value is in the form of user value.

Note: before call the function you need to ensure that the iterator is valid.

pub async fn rewind(&mut self) -> HummockResult<()>

Resets the iterating position to the beginning.

pub async fn seek(&mut self, user_key: UserKey<&[u8]>) -> HummockResult<()>

Resets the iterating position to the first position where the key >= provided key.

pub fn is_valid(&self) -> bool

Indicates whether the iterator can be used.

pub fn collect_local_statistic(&self, stats: &mut StoreLocalStatistic)

async fn try_advance_to_next_valid(&mut self) -> HummockResult<()>

Advance the inner iterator to a valid position, in which the entry can be exposed. Iterator will not be advanced if it already pointed to a valid position.

fn user_key_out_of_range(&self, user_key: UserKey<&[u8]>) -> bool