Struct polars_core::chunked_array::object::ObjectArray

pub struct ObjectArray<T>where
    T: PolarsObject,{ /* private fields */ }

Available on crate feature object only.

Implementations

impl<T> ObjectArray<T>where
    T: PolarsObject,

pub fn values(&self) -> &Arc<Vec<T>>

Get a reference to the underlying data

pub fn value(&self, index: usize) -> &T

Get a value at a certain index location

pub unsafe fn value_unchecked(&self, index: usize) -> &T

Get a value at a certain index location

Safety

This does not any bound checks. The caller needs to ensure the index is within the size of the array.

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

Check validity

Safety

No bounds checks

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

Check validity

Safety

No bounds checks

Trait Implementations

impl<T> Array for ObjectArray<T>where
    T: PolarsObject,

fn as_any(&self) -> &dyn Any

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

fn data_type(&self) -> &ArrowDataType

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

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

Slices the Array, returning a new Box<dyn Array>.

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

Slices the Array, returning a new Box<dyn Array>.

fn len(&self) -> usize

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

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.

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

Clones this Array with a new new assigned bitmap.

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

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

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

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

fn null_count(&self) -> usize

The number of null slots on this Array.

fn is_empty(&self) -> bool

whether the array is empty

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

Returns whether slot i is null.

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

Returns whether slot i is valid.

impl<T> Clone for ObjectArray<T>where
    T: PolarsObject + Clone,

fn clone(&self) -> ObjectArray<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for ObjectArray<T>where
    T: PolarsObject + Debug,

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

Formats the value using the given formatter.

impl<'a, T: PolarsObject> IntoIterator for &'a ObjectArray<T>

type Item = Option<&'a T>

The type of the elements being iterated over.

type IntoIter = ObjectIter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PolarsObject> ArrowArray for ObjectArray<T>