Struct polars::chunked_array::ops::SortOptions

pub struct SortOptions {
    pub descending: bool,
    pub nulls_last: bool,
    pub multithreaded: bool,
    pub maintain_order: bool,
}

Options for single series sorting.

Indicating the order of sorting, nulls position, multithreading, and maintaining order.

Example

let s = Series::new("a", [Some(5), Some(2), Some(3), Some(4), None].as_ref());
let sorted = s
    .sort(
        SortOptions::default()
            .with_order_descending(true)
            .with_nulls_last(true)
            .with_multithreaded(false),
    )
    .unwrap();
assert_eq!(
    sorted,
    Series::new("a", [Some(5), Some(4), Some(3), Some(2), None].as_ref())
);

Fields

descending: bool

If true sort in descending order. Default false.

nulls_last: bool

Whether place null values last. Default false.

multithreaded: bool

If true sort in multiple threads. Default true.

maintain_order: bool

If true maintain the order of equal elements. Default false.

Implementations

impl SortOptions

pub fn new() -> SortOptions

Create SortOptions with default values.

pub fn with_order_descending(self, enabled: bool) -> SortOptions

Specify sorting order for the column. Default false.

pub fn with_nulls_last(self, enabled: bool) -> SortOptions

Whether place null values last. Default false.

pub fn with_multithreaded(self, enabled: bool) -> SortOptions

Whether sort in multiple threads. Default true.

pub fn with_maintain_order(self, enabled: bool) -> SortOptions

Whether maintain the order of equal elements. Default false.

pub fn with_order_reversed(self) -> SortOptions

Reverse the order of sorting.

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 From<&SortMultipleOptions> for SortOptions

fn from(value: &SortMultipleOptions) -> SortOptions

Converts to this type from the input type.

impl From<&SortOptions> for SortMultipleOptions

fn from(value: &SortOptions) -> SortMultipleOptions

Converts to this type from the input type.

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 PartialEq for SortOptions

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

impl Eq for SortOptions

impl StructuralPartialEq for SortOptions