Trait polars_arrow::array::Array

source ·

pub trait Array:
    Send
    + Sync
    + DynClone
    + 'static {
Show 18 methods    // Required methods
    fn as_any(&self) -> &dyn Any;
    fn as_any_mut(&mut self) -> &mut dyn Any;
    fn len(&self) -> usize;
    fn data_type(&self) -> &ArrowDataType;
    fn validity(&self) -> Option<&Bitmap>;
    fn split_at_boxed(&self, offset: usize) -> (Box<dyn Array>, Box<dyn Array>);
    unsafe fn split_at_boxed_unchecked(
        &self,
        offset: usize,
    ) -> (Box<dyn Array>, Box<dyn Array>);
    fn slice(&mut self, offset: usize, length: usize);
    unsafe fn slice_unchecked(&mut self, offset: usize, length: usize);
    fn with_validity(&self, validity: Option<Bitmap>) -> Box<dyn Array>;
    fn to_boxed(&self) -> Box<dyn Array>;

    // Provided methods
    fn is_empty(&self) -> bool { ... }
    fn null_count(&self) -> usize { ... }
    fn is_null(&self, i: usize) -> bool { ... }
    unsafe fn is_null_unchecked(&self, i: usize) -> bool { ... }
    fn is_valid(&self, i: usize) -> bool { ... }
    fn sliced(&self, offset: usize, length: usize) -> Box<dyn Array> { ... }
    unsafe fn sliced_unchecked(
        &self,
        offset: usize,
        length: usize,
    ) -> Box<dyn Array> { ... }
}

Expand description

A trait representing an immutable Arrow array. Arrow arrays are trait objects that are infallibly downcasted to concrete types according to the Array::data_type.

Required Methods§

source

fn as_any(&self) -> &dyn Any

Converts itself to a reference of Any, which enables downcasting to concrete types.

source

fn as_any_mut(&mut self) -> &mut dyn Any

Converts itself to a mutable reference of Any, which enables mutable downcasting to concrete types.

source

fn len(&self) -> usize

The length of the Array. Every array has a length corresponding to the number of elements (slots).

source

fn data_type(&self) -> &ArrowDataType

The ArrowDataType of the Array. In combination with Array::as_any, this can be used to downcast trait objects (dyn Array) to concrete arrays.

source

fn validity(&self) -> Option<&Bitmap>

The validity of the Array: every array has an optional Bitmap that, when available specifies whether the array slot is valid or not (null). When the validity is None, all slots are valid.

source

fn split_at_boxed(&self, offset: usize) -> (Box<dyn Array>, Box<dyn Array>)

Split Self at offset into two boxed Arrays where offset <= self.len().

source

unsafe fn split_at_boxed_unchecked( &self, offset: usize, ) -> (Box<dyn Array>, Box<dyn Array>)

Split Self at offset into two boxed Arrays without checking offset <= self.len().

§Safety

Safe if offset <= self.len().

source

fn slice(&mut self, offset: usize, length: usize)

Slices this Array.

§Implementation

This operation is O(1) over len.

§Panic

This function panics iff offset + length > self.len().

source

unsafe fn slice_unchecked(&mut self, offset: usize, length: usize)

Slices the Array.

§Implementation

This operation is O(1).

§Safety

The caller must ensure that offset + length <= self.len()

source

fn with_validity(&self, validity: Option<Bitmap>) -> Box<dyn Array>

Clones this Array with a new new assigned bitmap.

§Panic

This function panics iff validity.len() != self.len().

source

fn to_boxed(&self) -> Box<dyn Array>

Clone a &dyn Array to an owned Box<dyn Array>.

Provided Methods§

source

fn is_empty(&self) -> bool

whether the array is empty

source

fn null_count(&self) -> usize

The number of null slots on this Array.

§Implementation

This is O(1) since the number of null elements is pre-computed.

source

fn is_null(&self, i: usize) -> bool

Returns whether slot i is null.

§Panic

Panics iff i >= self.len().

source

unsafe fn is_null_unchecked(&self, i: usize) -> bool

Returns whether slot i is null.

§Safety

The caller must ensure i < self.len()

source

fn is_valid(&self, i: usize) -> bool

Returns whether slot i is valid.

§Panic

Panics iff i >= self.len().

source

fn sliced(&self, offset: usize, length: usize) -> Box<dyn Array>

Returns a slice of this Array.

§Implementation

This operation is O(1) over len.

§Panic

This function panics iff offset + length > self.len().

source

unsafe fn sliced_unchecked( &self, offset: usize, length: usize, ) -> Box<dyn Array>

Returns a slice of this Array.

§Implementation

This operation is O(1) over len, as it amounts to increase two ref counts and moving the struct to the heap.

§Safety

The caller must ensure that offset + length <= self.len()

Trait polars_arrow::array::ArrayCopy item path

Required Methods§

fn as_any(&self) -> &dyn Any

fn as_any_mut(&mut self) -> &mut dyn Any

fn len(&self) -> usize

fn data_type(&self) -> &ArrowDataType

fn validity(&self) -> Option<&Bitmap>

fn split_at_boxed(&self, offset: usize) -> (Box<dyn Array>, Box<dyn Array>)

unsafe fn split_at_boxed_unchecked( &self, offset: usize, ) -> (Box<dyn Array>, Box<dyn Array>)

§Safety

fn slice(&mut self, offset: usize, length: usize)

§Implementation

§Panic

unsafe fn slice_unchecked(&mut self, offset: usize, length: usize)

§Implementation

§Safety

fn with_validity(&self, validity: Option<Bitmap>) -> Box<dyn Array>

§Panic

fn to_boxed(&self) -> Box<dyn Array>

Provided Methods§

fn is_empty(&self) -> bool

fn null_count(&self) -> usize

§Implementation

fn is_null(&self, i: usize) -> bool

§Panic

unsafe fn is_null_unchecked(&self, i: usize) -> bool

§Safety

fn is_valid(&self, i: usize) -> bool

§Panic

fn sliced(&self, offset: usize, length: usize) -> Box<dyn Array>

§Implementation

§Panic

unsafe fn sliced_unchecked( &self, offset: usize, length: usize, ) -> Box<dyn Array>

§Implementation

§Safety

Trait Implementations§

impl<'a> AsRef<dyn Array + 'a> for dyn Array

fn as_ref(&self) -> &(dyn Array + 'a)

impl Debug for dyn Array + '_

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

impl From<&(dyn Array + 'static)> for ArrayRef

fn from(value: &dyn Array) -> Self

impl From<&dyn Array> for Box<dyn Array>

fn from(value: &dyn Array) -> Self

impl From<Arc<dyn Array>> for Box<dyn Array>

fn from(value: ArrayRef) -> Self

impl<O: Offset> PartialEq<&(dyn Array + 'static)> for BinaryArray<O>

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

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

impl PartialEq<&(dyn Array + 'static)> for BooleanArray

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

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

impl<K: DictionaryKey> PartialEq<&(dyn Array + 'static)> for DictionaryArray<K>

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

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

impl PartialEq<&(dyn Array + 'static)> for FixedSizeBinaryArray

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

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

impl PartialEq<&(dyn Array + 'static)> for FixedSizeListArray

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

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

impl<O: Offset> PartialEq<&(dyn Array + 'static)> for ListArray<O>

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

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

impl PartialEq<&(dyn Array + 'static)> for MapArray

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

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

impl PartialEq<&(dyn Array + 'static)> for NullArray

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

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

impl<T: NativeType> PartialEq<&(dyn Array + 'static)> for PrimitiveArray<T>

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

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

impl PartialEq<&(dyn Array + 'static)> for StructArray

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

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

impl PartialEq<&(dyn Array + 'static)> for UnionArray

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

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

impl<O: Offset> PartialEq<&(dyn Array + 'static)> for Utf8Array<O>

Trait polars_arrow::array::Array