Struct lance_core::utils::mask::RowIdTreeMap

pub struct RowIdTreeMap { /* private fields */ }

A collection of row ids.

This is similar to a [RoaringTreemap] but it is optimized for the case where entire fragments are selected or deselected.

Implementations

impl RowIdTreeMap

pub fn new() -> Self

Create an empty set

pub fn is_empty(&self) -> bool

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

The number of rows in the map

If there are any “full fragment” items then this is unknown and None is returned

pub fn row_ids(&self) -> Option<impl Iterator<Item = RowAddress> + '_>

An iterator of row ids

If there are any “full fragment” items then this can’t be calculated and None is returned

pub fn insert_bitmap(&mut self, fragment: u32, bitmap: RoaringBitmap)

Add a bitmap for a single fragment

pub fn insert_fragment(&mut self, fragment_id: u32)

Add a whole fragment to the set

pub fn contains(&self, value: u64) -> bool

Returns whether the set contains the given value

pub fn remove_fragments(&mut self, frag_ids: impl IntoIterator<Item = u32>)

pub fn serialized_size(&self) -> usize

Compute the serialized size of the set.

pub fn serialize_into<W: Write>(&self, writer: W) -> Result<()>

Serialize the set into the given buffer

The serialization format is not stable.

The serialization format is:

• u32: num_entries for each entry:
  • u32: fragment_id
  • u32: bitmap size

If bitmap size is zero then the entire fragment is selected.

pub fn deserialize_from<R: Read>(reader: R) -> Result<Self>

Deserialize the set from the given buffer

Trait Implementations

impl BitAnd for RowIdTreeMap

type Output = RowIdTreeMap

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitOr for RowIdTreeMap

type Output = RowIdTreeMap

The resulting type after applying the | operator.

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

Performs the | operation.

impl Clone for RowIdTreeMap

fn clone(&self) -> RowIdTreeMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RowIdTreeMap

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

Formats the value using the given formatter.

impl Default for RowIdTreeMap

fn default() -> RowIdTreeMap

Returns the “default value” for a type.

impl<'a> Extend<&'a u64> for RowIdTreeMap

fn extend<T: IntoIterator<Item = &'a u64>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<u64> for RowIdTreeMap

fn extend<T: IntoIterator<Item = u64>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'a> FromIterator<&'a u64> for RowIdTreeMap

fn from_iter<T: IntoIterator<Item = &'a u64>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<u64> for RowIdTreeMap

fn from_iter<T: IntoIterator<Item = u64>>(iter: T) -> Self

Creates a value from an iterator.

impl PartialEq for RowIdTreeMap

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for RowIdTreeMap