Expand description
Re-exports APIs from arrow_array
Macros
Downcast an
Array to a DictionaryArray based on its DataType, accepts
a number of subsequent patterns to match the data typeDowncast an
Array to a PrimitiveArray based on its DataType
accepts a number of subsequent patterns to match the data typeStructs
An generic representation of Arrow array data which encapsulates common attributes and
operations for Arrow array. Specific operations for different arrays types (e.g.,
primitive, list, struct) are implemented in
Array.Builder for
ArrayData typeAn iterator that returns Some(T) or None, that can be used on any
ArrayAccessorArray of bools
Array builder for fixed-width primitive types
Builder for creating a
Buffer object.Layout specification for a data type
Array Builder for
Decimal128ArrayArray Builder for
Decimal256ArrayA generic
Array for fixed width decimal numbersA dictionary array where each element is a single value indexed by an integer key.
This is mostly used to represent strings or a limited set of primitive types as integers,
for example when doing NLP analysis or representing chromosomes by name.
An array where each element is a fixed-size sequence of bytes.
A list array where each element is a fixed-size sequence of values with the same
type whose maximum length is represented by a i32.
Array builder for
FixedSizeListArraySee
BinaryArray and LargeBinaryArray for storing
binary data.Array builder for
GenericBinaryArrayGeneric struct for a variable-size list array.
Array builder for
GenericListArrayGeneric struct for [Large]StringArray
Array builder for
GenericStringArrayA nested array type where each record is a key-value map.
Keys should always be non-null, but values can be null.
This struct is used as an adapter when creating
PrimitiveArray from an iterator.
FromIterator for PrimitiveArray takes an iterator where the elements can be into
this struct. So once implementing From or Into trait for a type, an iterator of
the type can be collected to PrimitiveArray.An Array where all elements are nulls
Array whose elements are of primitive types.
Array builder for fixed-width primitive types
Array builder for
DictionaryArray. For example to map a set of byte indices
to f32 values. Note that the use of a HashMap here will not scale to very large
arrays or result in an ordered dictionary.Array builder for
DictionaryArray that stores Strings. For example to map a set of byte indices
to String values. Note that the use of a HashMap here will not scale to very large
arrays or result in an ordered dictionary.A nested array type where each child (called field) is represented by a separate
array.
Array builder for Struct types.
A strongly-typed wrapper around a
DictionaryArray that implements ArrayAccessor
allowing fast access to its elementsAn Array that can represent slots of varying types.
Builder type for creating a new
UnionArray.Enums
Layout specification for a single data type buffer
Define capacities of child data or data buffers.
Traits
Trait for dealing with different types of array at runtime when the type of the
array is not known in advance.
A generic trait for accessing the values of an
ArrayTrait for dealing with different array builders at runtime
Trait bridging the dynamic-typed nature of Arrow (via
DataType) with the
static-typed nature of rust types (ArrowNativeType) for all types that implement ArrowNativeType.trait declaring an offset size, relevant for i32 vs i64 array types.
Functions
returns a comparison function that compares two values at two different positions
between the two arrays.
The arrays’ types must be equal.
Exports an array to raw pointers of the C Data Interface provided by the consumer.
Return the expected
DataTypeLayout Arrays of this data
type are expected to haveConstructs an array using the input
data.
Returns a reference-counted Array instance.Creates a new array from two FFI pointers. Used to import arrays from the C Data Interface
Returns a builder with capacity
capacity that corresponds to the datatype DataType
This function is useful to construct arrays from an arbitrary vectors with known/expected
schema.Creates a new empty array
Creates a new array of
data_type of length length filled
entirely of NULL valuesType Definitions
A reference-counted reference to a generic
Array.An array where each element contains 0 or more bytes.
The byte length of each element is represented by an i32.
Decimal128Array stores fixed width decimal numbers,
with a fixed precision and scale.Decimal256Array stores fixed width decimal numbers,
with a fixed precision and scaleCompare the values at two arbitrary indices in two arrays.
Example: Using
collectExample: Using
collectExample: Using
collectExample: Using
collectA dictionary array where each element is a single value indexed by an integer key.
Example: Using
collectA dictionary array where each element is a single value indexed by an integer key.
Example: Using
collectA dictionary array where each element is a single value indexed by an integer key.
Example: Using
collectA dictionary array where each element is a single value indexed by an integer key.
An array where each element contains 0 or more bytes.
The byte length of each element is represented by an i64.
A list array where each element is a variable-sized sequence of values with the same
type whose memory offsets between elements are represented by a i64.
An array where each element is a variable-sized sequence of bytes representing a string
whose maximum length (in bytes) is represented by a i64.
A list array where each element is a variable-sized sequence of values with the same
type whose memory offsets between elements are represented by a i32.
an iterator that returns Some(T) or None, that can be used on any PrimitiveArray
An array where each element is a variable-sized sequence of bytes representing a string
whose maximum length (in bytes) is represented by a i32.
A primitive array where each element is of type
TimestampMicrosecondType.
See examples for TimestampSecondArray.A primitive array where each element is of type
TimestampMillisecondType.
See examples for TimestampSecondArray.A primitive array where each element is of type
TimestampNanosecondType.
See examples for TimestampSecondArray.A primitive array where each element is of type TimestampSecondType.
See also
Timestamp.Example: Using
collectA dictionary array where each element is a single value indexed by an integer key.
Example: Using
collectA dictionary array where each element is a single value indexed by an integer key.
Example: Using
collectA dictionary array where each element is a single value indexed by an integer key.
Example: Using
collectA dictionary array where each element is a single value indexed by an integer key.