Struct arrow_row::SortField

pub struct SortField { /* private fields */ }

Configure the data type and sort order for a given column

Implementations

impl SortField

pub fn new(data_type: DataType) -> Self

Create a new column with the given data type

pub fn new_with_options(data_type: DataType, options: SortOptions) -> Self

Create a new column with the given data type and SortOptions

pub fn preserve_dictionaries(self, preserve_dictionaries: bool) -> Self

By default dictionaries are preserved as described on RowConverter

However, this process requires maintaining and incrementally updating an order-preserving mapping of dictionary values. This is relatively expensive computationally but reduces the size of the encoded rows, minimising memory usage and potentially yielding faster comparisons.

Some applications may wish to instead trade-off space efficiency, for improved encoding performance, by instead encoding dictionary values directly

When preserve_dictionaries is true, fields will instead be encoded as their underlying value, reversing any dictionary encoding

pub fn size(&self) -> usize

Return size of this instance in bytes.

Includes the size of Self.

Trait Implementations

impl Clone for SortField

fn clone(&self) -> SortField

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SortField

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

Formats the value using the given formatter.

impl PartialEq<SortField> for SortField

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

impl StructuralEq for SortField

impl StructuralPartialEq for SortField