Enum TextArray 

#[repr(C, align(64))]
pub enum TextArray {
    String32(Arc<StringArray<u32>>),
    String64(Arc<StringArray<u64>>),
    Categorical8(Arc<CategoricalArray<u8>>),
    Categorical16(Arc<CategoricalArray<u16>>),
    Categorical32(Arc<CategoricalArray<u32>>),
    Categorical64(Arc<CategoricalArray<u64>>),
    Null,
}

TextArray

Unified Text array container

Purpose

Exists to unify string and categorical operations, simplify API’s and streamline user ergonomics.

Usage:

• It is accessible from Array using .str(), and provides typed variant access via for e.g., .str64(), so one can drill down to the required granularity via myarr.str().str64()
• This streamlines function implementations, and, despite the additional enum layer, matching lanes in many real-world scenarios. This is because one can for e.g., unify a function signature with impl Into<TextArray>, and all of the subtypes, plus Array and TextArray, all qualify.
• Additionally, you can then use one Text implementation on the enum dispatch arm for all Text variants, or, in many cases, for the entire text arm when they are the same. This is mostly useful for the NumericArray enum where unifying floats and integers is a very common pattern, however there may be are cases where it’s useful for Categorical and String data too. For e.g., you can do a match on TextArray then just handle those two cases explicitly, or for e.g., accept impl Into<TextArray>, then simply case it to String for some string ops when feeling barbarian vibes.

Typecasting behaviour

• If the enum already holds the given type (which should be known at compile-time), then using accessors like .str32() is zero-cost, as it transfers ownership.
• If you want to keep the original, of course use .clone() beforehand.
• If you use an accessor to a different base type, e.g., .cat32() when it’s a .str32() already in the enum, it will convert it. Therefore, be mindful of performance when this occurs.

Variants

String32(Arc<StringArray<u32>>)

String64(Arc<StringArray<u64>>)

Categorical8(Arc<CategoricalArray<u8>>)

Categorical16(Arc<CategoricalArray<u16>>)

Categorical32(Arc<CategoricalArray<u32>>)

Categorical64(Arc<CategoricalArray<u64>>)

Null

Implementations

impl TextArray

pub fn len(&self) -> usize

Returns the logical length of the text array.

pub fn delete_range(&mut self, start: usize, end: usize)

Removes the rows in [start, end), shifting later rows left. A shared inner array is cloned first i.e. copy-on-write.

Panics

Panics if start > end or end > len.

pub fn null_mask(&self) -> Option<&Bitmask>

Returns the underlying null mask, if any.

pub fn has_nulls(&self) -> bool

Returns true when the variant holds at least one null.

Delegates to each inner array’s MaskedArray::has_nulls; Null is treated as empty (no elements means no nulls).

pub fn append_array(&mut self, other: &Self)

Appends all values (and null mask if present) from other into self.

Panics if the two arrays are of different variants or incompatible types.

This function uses copy-on-write semantics for arrays wrapped in Arc. If self is the only owner of its data, appends are performed in place without copying. If the array data is shared (Arc reference count > 1), the data is first cloned (so the mutation does not affect other owners), and the append is then performed on the unique copy.

This ensures that calling append_array never mutates data referenced elsewhere, but also avoids unnecessary cloning when the data is uniquely owned.

pub fn append_range( &mut self, other: &Self, offset: usize, len: usize, ) -> Result<(), MinarrowError>

pub fn insert_rows( &mut self, index: usize, other: &Self, ) -> Result<(), MinarrowError>

Inserts all values (and null mask if present) from other into self at the specified index.

This is an O(n) operation.

Returns an error if the two arrays are of different variants or incompatible types, or if the index is out of bounds.

This function uses copy-on-write semantics for arrays wrapped in Arc.

pub fn split(self, index: usize) -> Result<(Self, Self), MinarrowError>

Splits the TextArray at the specified index, consuming self and returning two arrays.

pub fn str32(&self) -> Arc<StringArray<u32>>

Returns the inner array as Arc<StringArray<u32>>, converting when the variant differs.

• The matching variant returns as a shared handle without copying data.
• Panics on failure. Consider the try variant for a safe alternative.

pub fn try_str32(&self) -> Result<Arc<StringArray<u32>>, MinarrowError>

Casts to StringArray

• Converts via TryFrom,
• The matching variant returns as a shared handle without copying data.

pub fn str64(&self) -> Arc<StringArray<u64>>

Returns the inner array as Arc<StringArray<u64>>, converting when the variant differs.

• The matching variant returns as a shared handle without copying data.
• Panics on failure. Consider the try variant for a safe alternative.

pub fn try_str64(&self) -> Result<Arc<StringArray<u64>>, MinarrowError>

Casts to StringArray

• Converts via From or TryFrom, depending on the inner type
• The matching variant returns as a shared handle without copying data.

pub fn cat32(&self) -> Arc<CategoricalArray<u32>>

Returns the inner array as Arc<CategoricalArray<u32>>, converting when the variant differs.

• The matching variant returns as a shared handle without copying data.
• Panics on failure. Consider the try variant for a safe alternative.

pub fn try_cat32(&self) -> Result<Arc<CategoricalArray<u32>>, MinarrowError>

Casts to CategoricalArray

• Converts via From or TryFrom, depending on the inner type
• The matching variant returns as a shared handle without copying data.

pub fn cat64(&self) -> Arc<CategoricalArray<u64>>

Returns the inner array as Arc<CategoricalArray<u64>>, converting when the variant differs.

• The matching variant returns as a shared handle without copying data.
• Panics on failure. Consider the try variant for a safe alternative.

pub fn try_cat64(&self) -> Result<Arc<CategoricalArray<u64>>, MinarrowError>

Casts to CategoricalArray

• Converts via From or TryFrom, depending on the inner type
• The matching variant returns as a shared handle without copying data.

pub fn cat8(&self) -> Arc<CategoricalArray<u8>>

Returns the inner array as Arc<CategoricalArray<u8>>, converting when the variant differs.

• The matching variant returns as a shared handle without copying data.
• Panics on failure. Consider the try variant for a safe alternative.

pub fn try_cat8(&self) -> Result<Arc<CategoricalArray<u8>>, MinarrowError>

Casts to CategoricalArray.

• Converts via From or TryFrom, depending on the inner type
• The matching variant returns as a shared handle without copying data.

pub fn cat16(&self) -> Arc<CategoricalArray<u16>>

Returns the inner array as Arc<CategoricalArray<u16>>, converting when the variant differs.

• The matching variant returns as a shared handle without copying data.
• Panics on failure. Consider the try variant for a safe alternative.

pub fn try_cat16(&self) -> Result<Arc<CategoricalArray<u16>>, MinarrowError>

Casts to CategoricalArray.

• Converts via From or TryFrom, depending on the inner type
• The matching variant returns as a shared handle without copying data.

Trait Implementations

impl ByteSize for TextArray

ByteSize for TextArray enum

fn est_bytes(&self) -> usize

Returns the estimated byte size of this object in memory.

impl Clone for TextArray

fn clone(&self) -> TextArray

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Concatenate for TextArray

fn concat(self, other: Self) -> Result<Self, MinarrowError>

Concatenates self with other, consuming both and returning a new instance.

impl Debug for TextArray

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

Formats the value using the given formatter.

impl Default for TextArray

fn default() -> TextArray

Returns the “default value” for a type.

impl Display for TextArray

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

Formats the value using the given formatter.

impl From<TextArray> for TextArrayV

fn from(array: TextArray) -> Self

Converts to this type from the input type.

impl PartialEq for TextArray

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

fn shape(&self) -> ShapeDim

Returns arbitrary Shape dimension for any data shape

fn shape_1d(&self) -> usize

Returns the first dimension shape

fn shape_2d(&self) -> (usize, usize)

Returns the first and second dimension shapes

fn shape_3d(&self) -> (usize, usize, usize)

Returns the first, second and third dimension shapes

fn shape_4d(&self) -> (usize, usize, usize, usize)

Returns the first, second, third and fourth dimension shapes

impl StructuralPartialEq for TextArray