Struct arrow::compute::kernels::sort::SortOptions

pub struct SortOptions {
    pub descending: bool,
    pub nulls_first: bool,
}

Options that define the sort order of a given column

The default sorts equivalently to of ASC NULLS FIRST in SQL (i.e. ascending order with nulls sorting before any other values).

Example creation

// configure using explicit initialization
let options = SortOptions {
  descending: false,
  nulls_first: true,
};
// Default is ASC NULLs First
assert_eq!(options, SortOptions::default());
assert_eq!(options.to_string(), "ASC NULLS FIRST");

// Configure using builder APIs
let options = SortOptions::default()
 .desc()
 .nulls_first();
assert_eq!(options.to_string(), "DESC NULLS FIRST");

// configure using explicit field values
let options = SortOptions::default()
 .with_descending(false)
 .with_nulls_first(false);
assert_eq!(options.to_string(), "ASC NULLS LAST");

Example operations

It is also possible to negate the sort options using the ! operator.

use arrow_schema::SortOptions;
let options = !SortOptions::default();
assert_eq!(options.to_string(), "DESC NULLS LAST");

Fields

descending: bool

Whether to sort in descending order

nulls_first: bool

Whether to sort nulls first

Implementations

impl SortOptions

pub fn new(descending: bool, nulls_first: bool) -> SortOptions

Create a new SortOptions struct

pub fn desc(self) -> SortOptions

Set this sort options to sort in descending order

See Self::with_descending to explicitly set the underlying field

pub fn asc(self) -> SortOptions

Set this sort options to sort in ascending order

See Self::with_descending to explicitly set the underlying field

pub fn nulls_first(self) -> SortOptions

Set this sort options to sort nulls first

See Self::with_nulls_first to explicitly set the underlying field

pub fn nulls_last(self) -> SortOptions

Set this sort options to sort nulls last

See Self::with_nulls_first to explicitly set the underlying field

pub fn with_descending(self, descending: bool) -> SortOptions

Set this sort options to sort descending if argument is true

pub fn with_nulls_first(self, nulls_first: bool) -> SortOptions

Set this sort options to sort nulls first if argument is true

Trait Implementations

impl Clone for SortOptions

fn clone(&self) -> SortOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SortOptions

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

Formats the value using the given formatter.

impl Default for SortOptions

fn default() -> SortOptions

Returns the “default value” for a type.

impl Display for SortOptions

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

Formats the value using the given formatter.

impl Hash for SortOptions

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Not for SortOptions

! operator is overloaded for SortOptions to invert boolean fields of the struct.

type Output = SortOptions

The resulting type after applying the ! operator.

fn not(self) -> SortOptions

Performs the unary ! operation.

impl Ord for SortOptions

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for SortOptions

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for SortOptions

impl Eq for SortOptions

impl StructuralPartialEq for SortOptions