Enum RowAddrMask 

pub enum RowAddrMask {
    AllowList(RowAddrTreeMap),
    BlockList(RowAddrTreeMap),
}

A mask that selects or deselects rows based on an allow-list or block-list.

Variants

AllowList(RowAddrTreeMap)

BlockList(RowAddrTreeMap)

Implementations

impl RowAddrMask

pub fn all_rows() -> Self

pub fn allow_nothing() -> Self

pub fn from_allowed(allow_list: RowAddrTreeMap) -> Self

pub fn from_block(block_list: RowAddrTreeMap) -> Self

pub fn block_list(&self) -> Option<&RowAddrTreeMap>

pub fn allow_list(&self) -> Option<&RowAddrTreeMap>

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 were valid

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

Also block the given addrs

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

Also allow the given addrs

pub fn into_arrow(&self) -> Result<BinaryArray>

Convert a mask into an arrow array

A row addr mask is not very arrow-compatible. We can’t make it a batch with two columns because the block list and allow list will have different lengths. Also, there is no Arrow type for compressed bitmaps.

However, we need to shove it into some kind of Arrow container to pass it along the datafusion stream. Perhaps, in the future, we can add row addr masks as first class types in datafusion, and this can be passed along as a mask / selection vector.

We serialize this as a variable length binary array with two items. The first item is the block list and the second item is the allow list.

pub fn from_arrow(array: &GenericBinaryArray<i32>) -> Result<Self>

Deserialize a row address mask from Arrow

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

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

Will be None if this is a BlockList (unbounded)

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

Iterate over the row addresses that are selected by the mask

This is only possible if this is an AllowList and the maps don’t contain any “full fragment” blocks.

Trait Implementations

impl BitAnd for RowAddrMask

type Output = RowAddrMask

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitOr for RowAddrMask

type Output = RowAddrMask

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl Clone for RowAddrMask

fn clone(&self) -> RowAddrMask

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RowAddrMask

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

Formats the value using the given formatter.

impl DeepSizeOf for RowAddrMask

fn deep_size_of_children(&self, context: &mut Context) -> usize

Returns an estimation of the heap-managed storage of this object. This does not include the size of the object itself.

fn deep_size_of(&self) -> usize

Returns an estimation of a total size of memory owned by the object, including heap-managed storage.

impl Default for RowAddrMask

fn default() -> Self

Returns the “default value” for a type.

impl Not for RowAddrMask

type Output = RowAddrMask

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl PartialEq for RowAddrMask

fn eq(&self, other: &RowAddrMask) -> 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 RowAddrMask