TextArray

Enum TextArray 

Source
#[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, }
Expand description

§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§

Source§

impl TextArray

Source

pub fn len(&self) -> usize

Returns the logical length of the text array.

Source

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

Returns the underlying null mask, if any.

Source

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.

Source

pub fn str32(self) -> Result<StringArray<u32>, MinarrowError>

Casts to StringArray

  • Converts via TryFrom,
  • Uses CloneOnWrite (COW) when it’s already a String32.
Source

pub fn str64(self) -> Result<StringArray<u64>, MinarrowError>

Casts to StringArray

  • Converts via From or TryFrom, depending on the inner type
  • Uses CloneOnWrite (COW) when it’s already a String64.
Source

pub fn cat32(self) -> Result<CategoricalArray<u32>, MinarrowError>

Casts to CategoricalArray

  • Converts via From or TryFrom, depending on the inner type
  • Uses CloneOnWrite (COW) when it’s already a Categorical32.
Source

pub fn cat64(self) -> Result<CategoricalArray<u64>, MinarrowError>

Casts to CategoricalArray

  • Converts via From or TryFrom, depending on the inner type
  • Uses CloneOnWrite (COW) when it’s already a Categorical32.
Source

pub fn cat8(self) -> Result<CategoricalArray<u8>, MinarrowError>

Casts to CategoricalArray.

  • Converts via From or TryFrom, depending on the inner type
  • Uses CloneOnWrite (COW) when it’s already a Categorical8.
Source

pub fn cat16(self) -> Result<CategoricalArray<u16>, MinarrowError>

Casts to CategoricalArray.

  • Converts via From or TryFrom, depending on the inner type
  • Uses CloneOnWrite (COW) when it’s already a Categorical16.

Trait Implementations§

Source§

impl Clone for TextArray

Source§

fn clone(&self) -> TextArray

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TextArray

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TextArray

Source§

fn default() -> TextArray

Returns the “default value” for a type. Read more
Source§

impl Display for TextArray

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<TextArray> for TextArrayV

Source§

fn from(array: TextArray) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for TextArray

Source§

fn eq(&self, other: &TextArray) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for TextArray

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> CustomValue for T
where T: Any + Send + Sync + Clone + PartialEq + Debug,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Downcasts the type as Any
Source§

fn deep_clone(&self) -> Arc<dyn CustomValue>

Returns a deep clone of the object. Read more
Source§

fn eq_box(&self, other: &(dyn CustomValue + 'static)) -> bool

Performs semantic equality on the boxed object. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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
Source§

impl<T> Key for T
where T: Clone,

Source§

fn align() -> usize

The alignment necessary for the key. Must return a power of two.
Source§

fn size(&self) -> usize

The size of the key in bytes.
Source§

unsafe fn init(&self, ptr: *mut u8)

Initialize the key in the given memory location. Read more
Source§

unsafe fn get<'a>(ptr: *const u8) -> &'a T

Get a reference to the key from the given memory location. Read more
Source§

unsafe fn drop_in_place(ptr: *mut u8)

Drop the key in place. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Print for T
where T: Display,

Source§

fn print(&self)
where Self: Display,

Source§

impl<T> ToCompactString for T
where T: Display,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T> ToStringFallible for T
where T: Display,

Source§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> PlanCallbackArgs for T

Source§

impl<T> PlanCallbackOut for T