Struct BlockCursor

pub struct BlockCursor<Conf: Config> { /* private fields */ }

Block iterator cursor, or position of iterable.

Created by BlockIter::cursor(), used by BlockIter::move_to(). Also can be built from index and DataBlock.

Allows to resume iteration from the last position, even if the source was mutated. Can be used with any BitSetInterface. Default constructed cursor will traverse bitset from the very begin.

Use-case

This can be used to split long iteration into a few sessions. You may want that in concurrent environment, when you can’t process whole iteration sequence fast, and want not to keep lock on resource all the time you process iteration sequence.

Example: you lock sets, make intersection iterator, read 40 blocks into buffer, take iterator to cursor, unlock sets, process buffer, lock sets, move iterator to cursor, and so on.

Implementations

impl<Conf: Config> BlockCursor<Conf>

pub fn start() -> Self

Constructs cursor that points to the start of bitset.

pub fn end() -> Self

Constructs cursor that points to the end of bitset.

Iterator moved to this cursor will always return None.

Trait Implementations

impl<Conf: Config> Clone for BlockCursor<Conf>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Conf: Config> Default for BlockCursor<Conf>

fn default() -> Self

Returns the “default value” for a type.

impl<Conf: Config> From<&DataBlock<<Conf as Config>::DataBitBlock>> for BlockCursor<Conf>

fn from(block: &DataBlock<Conf::DataBitBlock>) -> Self

Build cursor that points to the block.

impl<Conf: Config> From<usize> for BlockCursor<Conf>

fn from(index: usize) -> Self

Build cursor that points to the block, that contains index.

impl<Conf: Config> Copy for BlockCursor<Conf>