Struct NdColumn 

pub struct NdColumn { /* private fields */ }

A validated nd column. Each row holds one NdArrowArray or a null.

Construction checks every row once, so Self::value is infallible and slices the storage without a copy.

Implementations

impl NdColumn

pub fn try_new(storage: StructArray) -> Result<Self>

Wrap and validate a storage array.

pub fn try_from_array(array: &dyn Array) -> Result<Self>

Wrap and validate a storage array given as an ArrayRef.

pub fn try_from_arrays<'a>( arrays: impl IntoIterator<Item = &'a NdArrowArray>, ) -> Result<Self>

Encode arrays as one row each. arrays must not be empty.

pub fn new_null(extension: NdArrayType, len: usize) -> Self

A column of len null rows.

pub fn extension_type(&self) -> &NdArrayType

The extension type of the column.

pub fn value_type(&self) -> &DataType

The Arrow type of the array values.

pub fn to_field(&self, name: impl Into<String>) -> Field

A field named name with the storage type and the extension tag.

pub fn len(&self) -> usize

The number of rows.

pub fn is_empty(&self) -> bool

True when the column has no rows.

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

True when row is null.

pub fn null_count(&self) -> usize

The number of null rows.

pub fn get(&self, row: usize) -> Option<NdArrowArray>

The nd array at row, or None for a null row.

pub fn value(&self, row: usize) -> NdArrowArray

The nd array at row. A null row gives a rank-0 null scalar, which broadcasts to an all-null array.

pub fn dimensions_at(&self, row: usize) -> Dimensions

The dimensions at row. A null row gives scalar dimensions.

pub fn iter(&self) -> impl ExactSizeIterator<Item = Option<NdArrowArray>> + '_

The array of each row, None for null rows.

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

A zero-copy slice of len rows from offset.

pub fn values_list(&self) -> &ListArray

The flat values of all rows (the child of the values list).

pub fn attrs_struct(&self) -> Option<&StructArray>

The attrs struct, or None when the column has no attributes.

pub fn storage(&self) -> &StructArray

The storage Struct array.

pub fn into_storage(self) -> StructArray

The storage Struct array, by value.

pub fn into_array_ref(self) -> ArrayRef

The storage as an ArrayRef.

Trait Implementations

impl Clone for NdColumn

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NdColumn

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

Formats the value using the given formatter.

impl From<NdColumn> for ArrayRef

fn from(column: NdColumn) -> Self

Converts to this type from the input type.

impl TryFrom<StructArray> for NdColumn

type Error = NdError

The type returned in the event of a conversion error.

fn try_from(storage: StructArray) -> Result<Self>

Performs the conversion.