Struct arrow2::array::FixedSizeListArray

pub struct FixedSizeListArray { /* private fields */ }

The Arrow’s equivalent to an immutable Vec<Option<[T; size]>> where T is an Arrow type. Cloning and slicing this struct is O(1).

Implementations

impl<'a> FixedSizeListArray

pub fn iter(
    &'a self
) -> ZipValidity<'a, Box<dyn Array>, ListValuesIter<'a, FixedSizeListArray>>

Returns an iterator of Option<Box<dyn Array>>

pub fn values_iter(&'a self) -> ListValuesIter<'a, FixedSizeListArray>

Returns an iterator of Box<dyn Array>

impl FixedSizeListArray

pub fn try_new(
    data_type: DataType,
    values: Box<dyn Array>,
    validity: Option<Bitmap>
) -> Result<Self, Error>

Creates a new FixedSizeListArray.

Errors

This function returns an error iff:

• The data_type’s physical type is not crate::datatypes::PhysicalType::FixedSizeList
• The data_type’s inner field’s data type is not equal to values.data_type.
• The length of values is not a multiple of size in data_type
• the validity’s length is not equal to values.len() / size.

pub fn new(
    data_type: DataType,
    values: Box<dyn Array>,
    validity: Option<Bitmap>
) -> Self

Creates a new FixedSizeListArray.

Panics

This function panics iff:

• The data_type’s physical type is not crate::datatypes::PhysicalType::FixedSizeList
• The data_type’s inner field’s data type is not equal to values.data_type.
• The length of values is not a multiple of size in data_type
• the validity’s length is not equal to values.len() / size.

pub const fn size(&self) -> usize

Returns the size (number of elements per slot) of this FixedSizeListArray.

pub fn from_data(
    data_type: DataType,
    values: Box<dyn Array>,
    validity: Option<Bitmap>
) -> Self

Alias for new

pub fn new_empty(data_type: DataType) -> Self

Returns a new empty FixedSizeListArray.

pub fn new_null(data_type: DataType, length: usize) -> Self

Returns a new null FixedSizeListArray.

pub fn boxed(self) -> Box<dyn Array>

Boxes self into a Box<dyn Array>.

pub fn arced(self) -> Arc<dyn Array>

Boxes self into a Arc<dyn Array>.

impl FixedSizeListArray

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

Returns a slice of this FixedSizeListArray.

Implementation

This operation is O(1).

Panics

panics iff offset + length > self.len()

pub unsafe fn slice_unchecked(&self, offset: usize, length: usize) -> Self

Returns a slice of this FixedSizeListArray.

Implementation

This operation is O(1).

Safety

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

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

Returns this FixedSizeListArray with a new validity.

Panic

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

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

Sets the validity of this FixedSizeListArray.

Panics

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

impl FixedSizeListArray

pub fn len(&self) -> usize

Returns the length of this array

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

The optional validity.

pub fn values(&self) -> &Box<dyn Array>

Returns the inner array.

pub fn value(&self, i: usize) -> Box<dyn Array>

Returns the Vec<T> at position i.

Panic:

panics iff i >= self.len()

pub unsafe fn value_unchecked(&self, i: usize) -> Box<dyn Array>

Returns the Vec<T> at position i.

Safety

Caller must ensure that i < self.len()

impl FixedSizeListArray

pub fn default_datatype(data_type: DataType, size: usize) -> DataType

Returns a DataType consistent with FixedSizeListArray.

Trait Implementations

impl Array for FixedSizeListArray

fn as_any(&self) -> &dyn Any

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

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 len(&self) -> usize

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

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.

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

whether the array is empty

fn null_count(&self) -> usize

The number of null slots on this Array.

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 Clone for FixedSizeListArray

fn clone(&self) -> FixedSizeListArray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FixedSizeListArray

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

Formats the value using the given formatter.

impl<'a> From<GrowableFixedSizeList<'a>> for FixedSizeListArray

fn from(val: GrowableFixedSizeList<'a>) -> Self

Converts to this type from the input type.

impl<M: MutableArray> From<MutableFixedSizeListArray<M>> for FixedSizeListArray

fn from(other: MutableFixedSizeListArray<M>) -> Self

Converts to this type from the input type.

impl<'a> IntoIterator for &'a FixedSizeListArray

type Item = Option<Box<dyn Array + 'static, Global>>

The type of the elements being iterated over.

type IntoIter = ZipValidity<'a, Box<dyn Array + 'static, Global>, ListValuesIter<'a, FixedSizeListArray>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IterableListArray for FixedSizeListArray

unsafe fn value_unchecked(&self, i: usize) -> Box<dyn Array>

Safety

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

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<FixedSizeListArray> for FixedSizeListArray

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.