Skip to main content

StructArray

Struct StructArray 

Source
pub struct StructArray { /* private fields */ }
Expand description

A column of named child columns of equal length.

Implementations§

Source§

impl StructArray

Source

pub fn try_new( fields: Vec<Field>, columns: Vec<ArrayRef>, validity: Option<Bitmap>, ) -> Result<Self>

Builds a struct array from its fields and columns.

§Errors
Source

pub fn try_new_with_len( fields: Vec<Field>, columns: Vec<ArrayRef>, len: usize, validity: Option<Bitmap>, ) -> Result<Self>

Builds a struct array with an explicit length.

Required for the zero-column case, and useful when the caller already knows the row count.

§Errors

The same set as StructArray::try_new, minus DataError::UnknownStructLength.

use astrs_data::array::{Array, StructArray};

let empty = StructArray::try_new_with_len(Vec::new(), Vec::new(), 4, None)?;
assert_eq!(empty.len(), 4);
assert_eq!(empty.num_columns(), 0);
Source

pub fn new_null(fields: Vec<Field>, len: usize) -> Result<Self>

An all-null struct array of len rows.

Every child column is itself all-null, which keeps the layout valid.

§Errors

DataError::InvalidFixedSize when a child type carries a non-positive fixed width.

Source

pub fn fields(&self) -> &[Field]

The struct’s fields, in column order.

Source

pub fn columns(&self) -> &[ArrayRef] ⓘ

The child columns, in field order.

Source

pub const fn num_columns(&self) -> usize

Number of child columns.

Source

pub fn column(&self, index: usize) -> Option<&ArrayRef>

The child column at index.

Source

pub fn column_by_name(&self, name: &str) -> Option<&ArrayRef>

The first child column named name.

Source

pub fn try_column_by_name(&self, name: &str) -> Result<&ArrayRef>

The first child column named name.

§Errors

DataError::FieldNotFound when no field has that name.

Source

pub fn value(&self, index: usize) -> Option<Self>

The row at index as a one-row struct array, ignoring validity.

Returns None only when index is out of range.

Source

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

The logical row at index: None when the row is null or out of range.

Source

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

A zero-copy sub-range, clamped to the array (the crate-wide slicing convention).

Every child column is sliced by the same window.

Source

pub fn try_slice(&self, offset: usize, len: usize) -> Result<Self>

Checked StructArray::slice.

§Errors

DataError::SliceOutOfBounds when the window leaves the array.

Source

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

Returns a copy with a different validity bitmap.

§Errors

DataError::ValidityLengthMismatch when the bitmap length is wrong.

Source

pub fn project(&self, indices: &[usize]) -> Result<Self>

A struct holding only the columns at indices, in the order given.

§Errors

DataError::IndexOutOfBounds when an index has no column.

Trait Implementations§

Source§

impl Array for StructArray

Source§

fn as_any(&self) -> &dyn Any

Erased self, for ArrayExt::downcast.
Source§

fn data_type(&self) -> &DataType

The array’s layout.
Source§

fn len(&self) -> usize

Number of logical slots.
Source§

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

The validity bitmap, or None when every slot is valid. Read more
Source§

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

A zero-copy sub-range. Read more
Source§

fn buffer_memory_size(&self) -> usize

Bytes of buffer memory this array pins, including shared allocations it only partly covers. Read more
Source§

fn children(&self) -> Vec<&ArrayRef> ⓘ

The child arrays this array owns, in field order. Empty for leaf types.
Source§

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

Structural equality against another array, used by the PartialEq implementation on dyn Array. Read more
Source§

fn is_empty(&self) -> bool

Returns true when the array has no slots.
Source§

fn null_count(&self) -> usize

Number of null slots.
Source§

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

Returns true when slot index is null. Out-of-range indices are reported as null.
Source§

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

Returns true when slot index holds a value.
Source§

impl Clone for StructArray

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StructArray

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for StructArray

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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.

Source§

impl<A> IntoArrayRef for A
where A: Array,

Source§

fn into_array_ref(self) -> ArrayRef

Moves self into a shared, dynamically typed column.
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.