Struct RowIdSequence 

pub struct RowIdSequence(/* private fields */);

A sequence of row ids.

Row ids are u64s that:

1. Are unique within a table (except for tombstones)
2. Are often but not always sorted and/or contiguous.

This sequence of row ids is optimized to be compact when the row ids are contiguous and sorted. However, it does not require that the row ids are contiguous or sorted.

We can make optimizations that assume uniqueness.

Implementations

impl RowIdSequence

pub fn new() -> Self

pub fn iter(&self) -> impl DoubleEndedIterator<Item = u64> + '_

pub fn len(&self) -> u64

pub fn is_empty(&self) -> bool

pub fn extend(&mut self, other: Self)

Combines this row id sequence with another row id sequence.

pub fn delete(&mut self, row_ids: impl IntoIterator<Item = u64>)

Remove a set of row ids from the sequence.

pub fn mask(&mut self, positions: impl IntoIterator<Item = u32>) -> Result<()>

Delete row ids by position.

pub fn slice(&self, offset: usize, len: usize) -> RowIdSeqSlice<'_>

pub fn get(&self, index: usize) -> Option<u64>

Get the row id at the given index.

If the index is out of bounds, this will return None.

pub fn select<'a>( &'a self, selection: impl Iterator<Item = usize> + 'a, ) -> impl Iterator<Item = u64> + 'a

Get row ids from the sequence based on the provided sorted offsets

Any out of bounds offsets will be ignored

Panics

If the input selection is not sorted, this function will panic

pub fn mask_to_offset_ranges(&self, mask: &RowIdMask) -> Vec<Range<u64>>

Given a mask of row ids, calculate the offset ranges of the row ids that are present in the sequence.

For example, given a mask that selects all even ids and a sequence that is [80..85, 86..90, 14]

this will return [0, 2, 4, 5, 7, 9] because the range expands to

[80, 81, 82, 83, 84, 86, 87, 88, 89, 14] with offsets [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9]

This function is useful when determining which row offsets to read from a fragment given a mask.

Trait Implementations

impl Clone for RowIdSequence

fn clone(&self) -> RowIdSequence

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RowIdSequence

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

Formats the value using the given formatter.

impl DeepSizeOf for RowIdSequence

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 RowIdSequence

fn default() -> RowIdSequence

Returns the “default value” for a type.

impl Display for RowIdSequence

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

Formats the value using the given formatter.

impl From<&[u64]> for RowIdSequence

fn from(row_ids: &[u64]) -> Self

Converts to this type from the input type.

impl From<&RowIdSequence> for RowIdTreeMap

fn from(row_ids: &RowIdSequence) -> Self

Converts to this type from the input type.

impl From<Range<u64>> for RowIdSequence

fn from(range: Range<u64>) -> Self

Converts to this type from the input type.

impl From<RowIdSequence> for RowIdSequence

fn from(sequence: RowIdSequence) -> Self

Converts to this type from the input type.

impl PartialEq for RowIdSequence

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

type Error = Error

The type returned in the event of a conversion error.

fn try_from(pb: RowIdSequence) -> Result<Self>

Performs the conversion.

impl Eq for RowIdSequence

impl StructuralPartialEq for RowIdSequence