Struct CategoricalToArrowConverter 

pub struct CategoricalToArrowConverter {
    pub converters: IndexMap<usize, CategoricalArrayToArrowConverter, RandomState>,
    pub persist_remap: bool,
    pub output_keys_only: bool,
}

Categorical converter that prunes unused categories.

Fields

converters: IndexMap<usize, CategoricalArrayToArrowConverter, RandomState>

Converters keyed by the Arc address of Arc<CategoricalMapping>.

Safety

The usize key remains valid as CategoricalArrayToArrowConverter holds a ref-count to the Arc<> that the key is derived from.

persist_remap: bool

Persist the key remap to ensure consistent mapping across multiple calls.

output_keys_only: bool

Return only the keys array when going to arrow.

Implementations

impl CategoricalToArrowConverter

pub fn array_to_arrow( &mut self, keys_arr: &(dyn Array + 'static), dtype: &DataType, compat_level: CompatLevel, ) -> Box<dyn Array>

Panics

Panics if:

• keys_arr is not of a Categorical or Enum type
• The arc address of the Arc<CategoricalMapping> is not present within self.converters (likely due to forgetting to call initialize() on this converter).

pub fn initialize(&mut self, dtype: &DataType)

Initializes categorical converters for all categorical mappings present in this dtype.