Enum datafusion_expr::sort_properties::SortProperties

pub enum SortProperties {
    Ordered(SortOptions),
    Unordered,
    Singleton,
}

To propagate SortOptions across the PhysicalExpr, it is insufficient to simply use Option<SortOptions>: There must be a differentiation between unordered columns and literal values, since literals may not break the ordering when they are used as a child of some binary expression when the other child has some ordering. On the other hand, unordered columns cannot maintain ordering when they take part in such operations.

Example: ((a_ordered + b_unordered) + c_ordered) expression cannot end up with sorted data; however the ((a_ordered + 999) + c_ordered) expression can. Therefore, we need two different variants for literals and unordered columns as literals are often more ordering-friendly under most mathematical operations.

Variants

Ordered(SortOptions)

Use the ordinary SortOptions struct to represent ordered data:

Unordered

Singleton

Implementations

impl SortProperties

pub fn add(&self, rhs: &Self) -> Self

pub fn sub(&self, rhs: &Self) -> Self

pub fn gt_or_gteq(&self, rhs: &Self) -> Self

pub fn and_or(&self, rhs: &Self) -> Self

Trait Implementations

impl Clone for SortProperties

fn clone(&self) -> SortProperties

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SortProperties

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

Formats the value using the given formatter.

impl Default for SortProperties

fn default() -> SortProperties

Returns the “default value” for a type.

impl Neg for SortProperties

type Output = SortProperties

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for SortProperties

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

impl StructuralPartialEq for SortProperties