Enum RowIdMask 

pub enum RowIdMask {
    AllowList(RowIdSet),
    BlockList(RowIdSet),
}

A mask over stable row ids based on an allow-list or block-list.

The semantics mirror RowAddrMask, but operate on stable row ids instead of physical row addresses.

Variants

AllowList(RowIdSet)

Only the ids in the set are selected.

BlockList(RowIdSet)

All ids are selected except those in the set.

Implementations

impl RowIdMask

pub fn all_rows() -> Self

Create a mask allowing all rows, this is an alias for Default.

pub fn allow_nothing() -> Self

Create a mask that doesn’t allow any row id.

pub fn from_allowed(allow_list: RowIdSet) -> Self

Create a mask from an allow list.

pub fn from_block(block_list: RowIdSet) -> Self

Create a mask from a block list.

pub fn selected(&self, row_id: u64) -> bool

True if the row id is selected by the mask, false otherwise.

pub fn selected_indices<'a>( &self, row_ids: impl Iterator<Item = &'a u64> + 'a, ) -> Vec<u64>

Return the indices of the input row ids that are selected by the mask.

pub fn also_block(self, block_list: RowIdSet) -> Self

Also block the given ids.

• AllowList(a) -> AllowList(a \\ block_list)
• BlockList(b) -> BlockList(b union block_list)

pub fn also_allow(self, allow_list: RowIdSet) -> Self

Also allow the given ids.

• AllowList(a) -> AllowList(a union allow_list)
• BlockList(b) -> BlockList(b \\ allow_list)

pub fn max_len(&self) -> Option<u64>

Return the maximum number of row ids that could be selected by this mask.

Will be None if this is a BlockList (unbounded).

pub fn iter_ids(&self) -> Option<Box<dyn Iterator<Item = u64> + '_>>

Iterate over the row ids that are selected by the mask.

This is only possible if this is an AllowList. For a BlockList the domain of possible row ids is unbounded.

Trait Implementations

impl Clone for RowIdMask

fn clone(&self) -> RowIdMask

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RowIdMask

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

Formats the value using the given formatter.

impl Default for RowIdMask

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for RowIdMask

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RowIdMask