Struct polars_core::chunked_array::object::ObjectArray

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

This is supported 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.

Trait Implementations

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

fn as_any(&self) -> &dyn Any

Returns the array as Any so that it can be downcasted to a specific implementation.

fn data(&self) -> &ArrayData

Returns a reference to the underlying data of this array.

fn data_ref(&self) -> &ArrayData

Returns a reference-counted pointer to the underlying data of this array.

fn data_type(&self) -> &ArrowDataType

Returns a reference to the DataType of this array.

fn slice(&self, offset: usize, length: usize) -> ArrayRef

Returns a zero-copy slice of this array with the indicated offset and length.

fn len(&self) -> usize

Returns the length (i.e., number of elements) of this array.

fn is_empty(&self) -> bool

Returns whether this array is empty.

fn offset(&self) -> usize

Returns the offset into the underlying data used by this array(-slice). Note that the underlying data can be shared by many arrays. This defaults to 0.

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

Returns whether the element at index is null. When using this function on a slice, the index is relative to the slice.

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

Returns whether the element at index is not null. When using this function on a slice, the index is relative to the slice.

fn null_count(&self) -> usize

Returns the total number of null values in this array.

fn get_buffer_memory_size(&self) -> usize

Returns the total number of bytes of memory occupied by the buffers owned by this array.

fn get_array_memory_size(&self) -> usize

Returns the total number of bytes of memory occupied physically by this array.

fn to_raw(
    &self
) -> Result<(*const FFI_ArrowArray, *const FFI_ArrowSchema), ArrowError>

returns two pointers that represent this array in the C Data Interface (FFI)

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

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> Debug for ObjectArray<T> where
    T: PolarsObject, 

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> JsonEqual for ObjectArray<T> where
    T: PolarsObject, 

fn equals_json(&self, _json: &[&Value]) -> bool

Checks whether arrow array equals to json array.

fn equals_json_values(&self, json: &[Value]) -> bool

Checks whether arrow array equals to json array.