Struct datafusion::physical_plan::sorts::SortKeyCursor

pub struct SortKeyCursor { /* private fields */ }

A SortKeyCursor is created from a RecordBatch, and a set of PhysicalExpr that when evaluated on the RecordBatch yield the sort keys.

Additionally it maintains a row cursor that can be advanced through the rows of the provided RecordBatch

SortKeyCursor::compare can then be used to compare the sort key pointed to by this row cursor, with that of another SortKeyCursor. A cursor stores a row comparator for each other cursor that it is compared to.

Implementations

impl SortKeyCursor

pub fn new(stream_idx: usize, batch_id: usize, rows: Rows) -> Self

Create a new SortKeyCursor

pub fn stream_idx(&self) -> usize

Return the stream index of this cursor

pub fn batch_id(&self) -> usize

Return the batch id of this cursor

pub fn is_finished(&self) -> bool

Return true if the stream is finished

pub fn advance(&mut self) -> usize

Returns the cursor’s current row, and advances the cursor to the next row

Trait Implementations

impl Debug for SortKeyCursor

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

Formats the value using the given formatter.

impl Ord for SortKeyCursor

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<SortKeyCursor> for SortKeyCursor

fn eq(&self, other: &Self) -> 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 PartialOrd<SortKeyCursor> for SortKeyCursor

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for SortKeyCursor