Struct RowCollection 

pub struct RowCollection {
    encoded: Bytes,
    metadata: Arc<[EncodedRowMetadata]>,
}

Collection of runs of sorted Rows represented as a single blob.

Note: the encoding format we use to represent Rows in this struct is not stable, and thus should never be persisted durably.

Fields

encoded: Bytes

Contiguous blob of encoded Rows.

metadata: Arc<[EncodedRowMetadata]>

Metadata about an individual Row in the blob.

Implementations

impl RowCollection

pub fn new(rows: Vec<(Row, NonZeroUsize)>, order_by: &[ColumnOrder]) -> Self

Create a new RowCollection from a collection of Rows. Sorts data by order_by.

Note that all row collections to be merged must be constructed with the same order_by to ensure a consistent sort order. Anything else is undefined behavior.

pub fn concat(&mut self, other: &RowCollection)

Concatenate another RowCollection onto self, copying and reallocating both sets of rows.

This does not reorder the rows; the output will be sorted only if the inputs are.

pub fn offset_limit(total: usize, offset: usize, limit: Option<usize>) -> usize

Adjust a row count for the provided offset and limit.

This is only marginally related to row collections, but many callers need to make this adjustment.

pub fn count(&self) -> usize

Total count of Rows represented by this collection.

pub fn entries(&self) -> usize

Total count of (Row, EncodedRowMetadata) pairs in this collection.

pub fn byte_len(&self) -> usize

Returns the number of bytes this RowCollection uses.

pub fn get(&self, idx: usize) -> Option<(&RowRef, &EncodedRowMetadata)>

Returns a RowRef for the entry at idx, if one exists.

pub fn merge_sorted(runs: &[Self], order_by: &[ColumnOrder]) -> RowCollection

“Sorts” the RowCollection by the column order in order_by. The output will be sorted if the inputs were all sorted by the given order; otherwise, the order is unspecified. In either case, the output will be a RowCollection that contains the full contents of all the input collections.

fn merge_sorted_inner<F>(runs: &[Self], cmp: &F) -> RowCollection

where F: Fn(&RowRef, &RowRef) -> Ordering,

Trait Implementations

impl Clone for RowCollection

fn clone(&self) -> RowCollection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RowCollection

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

Formats the value using the given formatter.

impl Default for RowCollection

fn default() -> RowCollection

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RowCollection

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoRowIterator for RowCollection

type Iter = RowCollectionIter

fn into_row_iter(self) -> Self::Iter

impl PartialEq for RowCollection

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RowCollection