Struct PathKey 

pub struct PathKey {
    pub field: FieldRef,
    pub direction: PathKeyDirection,
    pub nulls: PathKeyNulls,
}

One column in an ordering guarantee. A PathKeys is a Vec representing a lexicographic ordering — the first pathkey dominates, the next breaks ties, and so on.

Fields

field: FieldRef

direction: PathKeyDirection

nulls: PathKeyNulls

Implementations

impl PathKey

pub fn asc(field: FieldRef) -> Self

Create an ascending pathkey with NULLS LAST (the PG default for ASC). Convenience constructor used by IndexScan when the index is ascending.

pub fn desc(field: FieldRef) -> Self

Create a descending pathkey with NULLS FIRST.

pub fn same_column_and_direction(&self, other: &PathKey) -> bool

Returns true when two pathkeys describe the same column in the same direction. Null placement is NOT compared — two pathkeys on the same column are equivalent for incremental-sort purposes regardless of null placement because sort stability handles the null edge case.

Trait Implementations

impl Clone for PathKey

fn clone(&self) -> PathKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PathKey

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

Formats the value using the given formatter.

impl PartialEq for PathKey

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

impl StructuralPartialEq for PathKey