Struct 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_iter(&self) -> ObjectValueIter<'_, T>

pub fn iter(&self) -> ZipValidity<&T, ObjectValueIter<'_, T>, BitmapIter<'_>>

Returns an iterator of Option<&T> over every element of this array.

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

Get a value at a certain index location

pub fn get(&self, index: usize) -> Option<&T>

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

pub fn with_validity(self, validity: Option<Bitmap>) -> Self

Returns this array with a new validity.

Panic

Panics iff validity.len() != self.len().

pub fn set_validity(&mut self, validity: Option<Bitmap>)

Sets the validity of this array.

Panics

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

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 dtype(&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.

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

Slices this [Array].

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

Slices the [Array].

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

Split [Self] at offset into two boxed [Array]s where offset <= self.len().

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

Split [Self] at offset into two boxed [Array]s without checking offset <= self.len().

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 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 has_nulls(&self) -> bool

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

Returns whether slot i is null.

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

Returns whether slot i is null.

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

Returns whether slot i is valid.

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

Returns a slice of this [Array].

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

Returns a slice of this [Array].

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

fn arr_from_iter<I: IntoIterator<Item = &'a T>>(iter: I) -> Self

fn try_arr_from_iter<E, I: IntoIterator<Item = Result<&'a T, E>>>( iter: I, ) -> Result<Self, E>

fn arr_from_iter_trusted<I>(iter: I) -> Self

where I: IntoIterator<Item = T>, <I as IntoIterator>::IntoIter: TrustedLen,

fn try_arr_from_iter_trusted<E, I>(iter: I) -> Result<Self, E>

where I: IntoIterator<Item = Result<T, E>>, <I as IntoIterator>::IntoIter: TrustedLen,

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

fn arr_from_iter<I: IntoIterator<Item = Option<&'a T>>>(iter: I) -> Self

fn try_arr_from_iter<E, I: IntoIterator<Item = Result<Option<&'a T>, E>>>( iter: I, ) -> Result<Self, E>

fn arr_from_iter_trusted<I>(iter: I) -> Self

where I: IntoIterator<Item = T>, <I as IntoIterator>::IntoIter: TrustedLen,

fn try_arr_from_iter_trusted<E, I>(iter: I) -> Result<Self, E>

where I: IntoIterator<Item = Result<T, E>>, <I as IntoIterator>::IntoIter: TrustedLen,

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<T: PolarsObject> From<Vec<T>> for ObjectArray<T>

fn from(values: Vec<T>) -> Self

Converts to this type from the input type.

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

Available on crate feature zip_with only.

type Scalar<'a> = &'a T

fn if_then_else(mask: &Bitmap, if_true: &Self, if_false: &Self) -> Self

fn if_then_else_broadcast_true( mask: &Bitmap, if_true: Self::Scalar<'_>, if_false: &Self, ) -> Self

fn if_then_else_broadcast_false( mask: &Bitmap, if_true: &Self, if_false: Self::Scalar<'_>, ) -> Self

fn if_then_else_broadcast_both( _dtype: ArrowDataType, mask: &Bitmap, if_true: Self::Scalar<'_>, if_false: Self::Scalar<'_>, ) -> Self

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> ParameterFreeDtypeStaticArray for ObjectArray<T>

fn get_dtype() -> ArrowDataType

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

fn check_bound(&self, offset: usize) -> bool

unsafe fn _split_at_unchecked(&self, offset: usize) -> (Self, Self)

Internal implementation of split_at_unchecked. For any usage, prefer the using split_at or split_at_unchecked.

fn split_at(&self, offset: usize) -> (Self, Self)

Split [Self] at offset where offset <= self.len().

unsafe fn split_at_unchecked(&self, offset: usize) -> (Self, Self)

Split [Self] at offset without checking offset <= self.len().

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

type ValueT<'a> = &'a T

type ZeroableValueT<'a> = Option<&'a T>

type ValueIterT<'a> = Iter<'a, T>

unsafe fn value_unchecked(&self, idx: usize) -> Self::ValueT<'_>

Safety

fn values_iter(&self) -> Self::ValueIterT<'_>

fn iter( &self, ) -> ZipValidity<Self::ValueT<'_>, Self::ValueIterT<'_>, BitmapIter<'_>>

fn with_validity_typed(self, validity: Option<Bitmap>) -> Self

fn full_null(length: usize, _dtype: ArrowDataType) -> Self

fn get(&self, idx: usize) -> Option<Self::ValueT<'_>>

unsafe fn get_unchecked(&self, idx: usize) -> Option<Self::ValueT<'_>>

Safety

fn last(&self) -> Option<Self::ValueT<'_>>

fn value(&self, idx: usize) -> Self::ValueT<'_>

fn as_slice(&self) -> Option<&[Self::ValueT<'_>]>

fn from_vec(v: Vec<Self::ValueT<'_>>, dtype: ArrowDataType) -> Self

fn from_zeroable_vec( v: Vec<Self::ZeroableValueT<'_>>, dtype: ArrowDataType, ) -> Self

fn full(length: usize, value: Self::ValueT<'_>, dtype: ArrowDataType) -> Self

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