Struct polars::chunked_array::object::ObjectArray

source · [−]

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

Implementations

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

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

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 + 'static)

Convert to trait object.

fn data_type(&self) -> &DataType

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

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

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

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

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

fn len(&self) -> usize

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

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. Read more

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

Sets the validity bitmap on this Array. Read more

fn to_boxed(&self) -> Box<dyn Array + 'static, Global>

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

fn is_empty(&self) -> bool

whether the array is empty

fn null_count(&self) -> usize

The number of null slots on this Array. Read more

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

Returns whether slot i is null. Read more

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

Returns whether slot i is valid. Read more

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

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

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

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

Formats the value using the given formatter. Read more

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

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) -> <&'a ObjectArray<T> as IntoIterator>::IntoIter

Creates an iterator from a value. Read more

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

Auto Trait Implementations

impl<T> RefUnwindSafe for ObjectArray<T> where
T: RefUnwindSafe,

impl<T> Send for ObjectArray<T>

impl<T> Sync for ObjectArray<T>

impl<T> Unpin for ObjectArray<T>

impl<T> UnwindSafe for ObjectArray<T> where
T: RefUnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · 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.

impl<A> IsValid for A where
A: ArrowArray,

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

Safety Read more

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

Safety Read more

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

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

impl<A> PolarsArray for A where
A: Array + ?Sized,

fn has_validity(&self) -> bool

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

fn vzip(self) -> V