Skip to main content

Module arrays

Module arrays 

Source
Expand description

Built-in array encodings.

Canonical arrays are the default uncompressed representation for a logical dtype: NullArray, BoolArray, PrimitiveArray, DecimalArray, VarBinViewArray, ListViewArray, FixedSizeListArray, StructArray, ExtensionArray, and VariantArray.

Utility and lazy arrays represent common transformations without immediately materializing their result. Examples include ChunkedArray for concatenation, ConstantArray for repeated values, DictArray for dictionary encoding, FilterArray for masked rows, SliceArray for views, and ScalarFnArray for deferred scalar-function execution.

Some public arrays are primarily internal building blocks. Their constructors and extension traits document the stable contract; avoid depending on undocumented slot order or metadata details.

Re-exports§

pub use bool::Bool;
pub use bool::BoolArray;
pub use chunked::Chunked;
pub use chunked::ChunkedArray;
pub use constant::Constant;
pub use constant::ConstantArray;
pub use datetime::TemporalArray;
pub use decimal::Decimal;
pub use decimal::DecimalArray;
pub use dict::Dict;
pub use dict::DictArray;
pub use extension::Extension;
pub use extension::ExtensionArray;
pub use filter::Filter;
pub use filter::FilterArray;
pub use fixed_size_list::FixedSizeList;
pub use fixed_size_list::FixedSizeListArray;
pub use interleave::Interleave;
pub use interleave::InterleaveArray;
pub use list::List;
pub use list::ListArray;
pub use listview::ListView;
pub use listview::ListViewArray;
pub use masked::Masked;
pub use masked::MaskedArray;
pub use null::Null;
pub use null::NullArray;
pub use patched::Patched;
pub use patched::PatchedArray;
pub use primitive::Primitive;
pub use primitive::PrimitiveArray;
pub use scalar_fn::ScalarFn;
pub use scalar_fn::ScalarFnArray;
pub use shared::Shared;
pub use shared::SharedArray;
pub use slice::Slice;
pub use slice::SliceArray;
pub use struct_::Struct;
pub use struct_::StructArray;
pub use varbin::VarBin;
pub use varbin::VarBinArray;
pub use varbinview::VarBinView;
pub use varbinview::VarBinViewArray;
pub use variant::Variant;
pub use variant::VariantArray;

Modules§

arbitrary
bool
chunked
constant
datetime
decimal
dict
Implementation of Dictionary encoding.
dict_test
extension
filter
fixed_size_list
interleave
The Interleave encoding: a lazy, random-access gather of N value arrays into one array, routed by a per-row (array_index, row_index) pair.
list
listview
masked
null
patched
An array that partially “patches” another array with new values.
primitive
scalar_fn
shared
slice
Reduce and execute adaptors for slice operations.
struct_
varbin
varbinview
variant

Functions§

assert_arrays_eq_impl
Implementation of assert_arrays_eq! — called by the macro after converting inputs to ArrayRef.