Struct polars_core::chunked_array::ops::sort::options::SortOptions
source · pub struct SortOptions {
pub descending: bool,
pub nulls_last: bool,
pub multithreaded: bool,
pub maintain_order: bool,
}
Expand description
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§
source§impl SortOptions
impl SortOptions
sourcepub fn with_order_descending(self, enabled: bool) -> Self
pub fn with_order_descending(self, enabled: bool) -> Self
Specify sorting order for the column. Default false
.
sourcepub fn with_nulls_last(self, enabled: bool) -> Self
pub fn with_nulls_last(self, enabled: bool) -> Self
Whether place null values last. Default false
.
sourcepub fn with_multithreaded(self, enabled: bool) -> Self
pub fn with_multithreaded(self, enabled: bool) -> Self
Whether sort in multiple threads. Default true
.
sourcepub fn with_maintain_order(self, enabled: bool) -> Self
pub fn with_maintain_order(self, enabled: bool) -> Self
Whether maintain the order of equal elements. Default false
.
sourcepub fn with_order_reversed(self) -> Self
pub fn with_order_reversed(self) -> Self
Reverse the order of sorting.
Trait Implementations§
source§impl Clone for SortOptions
impl Clone for SortOptions
source§fn clone(&self) -> SortOptions
fn clone(&self) -> SortOptions
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for SortOptions
impl Debug for SortOptions
source§impl Default for SortOptions
impl Default for SortOptions
source§impl From<&SortMultipleOptions> for SortOptions
impl From<&SortMultipleOptions> for SortOptions
source§fn from(value: &SortMultipleOptions) -> Self
fn from(value: &SortMultipleOptions) -> Self
Converts to this type from the input type.
source§impl From<&SortOptions> for SortMultipleOptions
impl From<&SortOptions> for SortMultipleOptions
source§fn from(value: &SortOptions) -> Self
fn from(value: &SortOptions) -> Self
Converts to this type from the input type.
source§impl Hash for SortOptions
impl Hash for SortOptions
source§impl PartialEq for SortOptions
impl PartialEq for SortOptions
source§fn eq(&self, other: &SortOptions) -> bool
fn eq(&self, other: &SortOptions) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.impl Copy for SortOptions
impl Eq for SortOptions
impl StructuralPartialEq for SortOptions
Auto Trait Implementations§
impl Freeze for SortOptions
impl RefUnwindSafe for SortOptions
impl Send for SortOptions
impl Sync for SortOptions
impl Unpin for SortOptions
impl UnwindSafe for SortOptions
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Checks if this value is equivalent to the given key. Read more
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key
and return true
if they are equal.source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more