Expand description
Statically typed implementations of Arrow Arrays
See arrow_array for examples and usage instructions
Structs
- 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
type - An iterator that returns Some(T) or None, that can be used on any
ArrayAccessor
- An array of boolean values
- Builder for
BooleanBuffer
- Builder for
BooleanArray
- Builder for creating a
Buffer
object. - Layout specification for a data type
- An array of dictionary encoded values
- An array of fixed size binary arrays
- Builder for
FixedSizeBinaryArray
- An array of fixed size arrays
- Builder for
FixedSizeListArray
- An array of variable length byte arrays
- Builder for
GenericByteArray
- Builder for
DictionaryArray
ofGenericByteArray
- Builder for
RunArray
ofGenericByteArray
- An array of variable length arrays
- Builder for
GenericListArray
- An array of key-value maps
- Builder for
MapArray
- An optional primitive value
- An array of null values
- An array of primitive values
- Builder for
PrimitiveArray
- Builder for
DictionaryArray
ofPrimitiveArray
- Builder for
RunArray
ofPrimitiveArray
- An array of run-end encoded values
- An array of structs
- Builder for
StructArray
- A
DictionaryArray
typed on its child values array - A
RunArray
typed typed on its child values array - An array of values of varying types
- Builder for
UnionArray
Enums
- Layout specification for a single data type buffer
- Define capacities of child data or data buffers.
Traits
- An array in the arrow columnar format
- A generic trait for accessing the values of an
Array
- Trait 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 implementArrowNativeType
. - An extension trait for
dyn Array
that provides ergonomic downcasting - A type that can be used within a variable-size array to encode offset information
Functions
- returns a comparison function that compares two values at two different positions between the two arrays. The arrays’ types must be equal.
- Downcasts a
dyn Array
to a concrete type - export_array_into_raw⚠DeprecatedExports 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 have - Constructs an array using the input
data
. Returns a reference-countedArray
instance. - Returns a builder with capacity
capacity
that corresponds to the datatypeDataType
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 lengthlength
filled entirely ofNULL
values
Type Definitions
- A reference-counted reference to a generic
Array
- An array of
[u8]
usingi32
offsets - Builder for
BinaryArray
- Builder for
DictionaryArray
ofBinaryArray
- Builder for
RunArray
ofBinaryArray
- an iterator that returns Some(T) or None, that can be used on any BooleanArray
- An array of days since UNIX epoch stored as
i32
- Buffer builder for 32-bit date type.
- A 32-bit date array builder.
- An array of milliseconds since UNIX epoch stored as
i64
- Buffer builder for 64-bit date type.
- A 64-bit date array builder.
- An array of 128-bit fixed point decimals
- Buffer builder for 128-bit decimal type.
- A decimal 128 array builder
- An array of 256-bit fixed point decimals
- Buffer builder for 256-bit decimal type.
- A decimal 256 array builder
- An array of elapsed durations in microseconds
- Buffer builder for elaspsed time of microseconds unit.
- An elapsed time in microseconds array builder.
- An array of elapsed durations in milliseconds
- Buffer builder for elaspsed time of milliseconds unit.
- An elapsed time in milliseconds array builder.
- An array of elapsed durations in nanoseconds
- Buffer builder for elaspsed time of nanoseconds unit.
- An elapsed time in nanoseconds array builder.
- An array of elapsed durations in seconds
- Buffer builder for elaspsed time of second unit.
- An elapsed time in seconds array builder.
- Compare the values at two arbitrary indices in two arrays.
- an iterator that returns Some(T) or None, that can be used on any FixedSizeBinaryArray
- An array of
f16
- Buffer builder for 16-bit floating point type.
- A 16-bit floating point array builder.
- An array of
f32
- Buffer builder for 32-bit floating point type.
- A 32-bit floating point array builder.
- An array of
f64
- Buffer builder for 64-bit floating point type.
- A 64-bit floating point array builder.
- See
BinaryArray
andLargeBinaryArray
for storing binary data - Array builder for
GenericBinaryArray
- an iterator that returns Some(T) or None, that can be used on any BinaryArray
- an iterator that returns Some(T) or None, that can be used on any ListArray
- See
StringArray
andLargeStringArray
for storing string data - Array builder for
GenericStringArray
- an iterator that returns Some(T) or None, that can be used on any Utf8Array
- An array of
i8
- Buffer builder for signed 8-bit integer type.
- A signed 8-bit integer array builder.
- A dictionary array indexed by
i8
- An array of
i16
- Buffer builder for signed 16-bit integer type.
- A signed 16-bit integer array builder.
- A dictionary array indexed by
i16
- A
RunArray
withi16
run ends - An array of
i32
- Buffer builder for signed 32-bit integer type.
- A signed 32-bit integer array builder.
- A dictionary array indexed by
i32
- A
RunArray
withi32
run ends - An array of
i64
- Buffer builder for signed 64-bit integer type.
- A signed 64-bit integer array builder.
- A dictionary array indexed by
i64
- A
RunArray
withi64
run ends - An array of “calendar” intervals in days and milliseconds
- Buffer builder for “calendar” interval in days and milliseconds.
- A “calendar” interval in days and milliseconds array builder.
- An array of “calendar” intervals in months, days, and nanoseconds
- Buffer builder “calendar” interval in months, days, and nanoseconds.
- A “calendar” interval in months, days, and nanoseconds array builder.
- An array of “calendar” intervals in months
- Buffer builder for “calendar” interval in months.
- A “calendar” interval in months array builder.
- An array of
[u8]
usingi64
offsets - Builder for
LargeBinaryArray
- Builder for
DictionaryArray
ofLargeBinaryArray
- Builder for
RunArray
ofLargeBinaryArray
- An array of variable size lists, storing offsets as
i64
. - Builder for
LargeListArray
- An array of
str
usingi64
offsets - Builder for
LargeStringArray
- Builder for
DictionaryArray
ofLargeStringArray
- Builder for
RunArray
ofLargeStringArray
- An array of variable size lists, storing offsets as
i32
. - Builder for
ListArray
- an iterator that returns Some(T) or None, that can be used on any PrimitiveArray
- An array of
str
usingi32
offsets - Builder for
StringArray
- Builder for
DictionaryArray
ofStringArray
- Builder for
RunArray
ofStringArray
- An array of milliseconds since midnight stored as
i32
- Buffer builder for 32-bit elaspsed time since midnight of millisecond unit.
- A 32-bit elaspsed time in milliseconds array builder.
- An array of seconds since midnight stored as
i32
- Buffer builder for 32-bit elaspsed time since midnight of second unit.
- A 32-bit elaspsed time in seconds array builder.
- An array of microseconds since midnight stored as
i64
- Buffer builder for 64-bit elaspsed time since midnight of microsecond unit.
- A 64-bit elaspsed time in microseconds array builder.
- An array of nanoseconds since midnight stored as
i64
- Buffer builder for 64-bit elaspsed time since midnight of nanosecond unit.
- A 64-bit elaspsed time in nanoseconds array builder.
- An array of microseconds since UNIX epoch stored as
i64
- Buffer builder for timestamp type of microsecond unit.
- A timestamp microsecond array builder.
- An array of milliseconds since UNIX epoch stored as
i64
- Buffer builder for timestamp type of millisecond unit.
- A timestamp millisecond array builder.
- An array of nanoseconds since UNIX epoch stored as
i64
- Buffer builder for timestamp type of nanosecond unit.
- A timestamp nanosecond array builder.
- An array of seconds since UNIX epoch stored as
i64
- Buffer builder for timestamp type of second unit.
- A timestamp second array builder.
- An array of
u8
- Buffer builder for usigned 8-bit integer type.
- An usigned 8-bit integer array builder.
- A dictionary array indexed by
u8
- An array of
u16
- Buffer builder for usigned 16-bit integer type.
- An usigned 16-bit integer array builder.
- A dictionary array indexed by
u16
- An array of
u32
- Buffer builder for usigned 32-bit integer type.
- An usigned 32-bit integer array builder.
- A dictionary array indexed by
u32
- An array of
u64
- Buffer builder for usigned 64-bit integer type.
- An usigned 64-bit integer array builder.
- A dictionary array indexed by
u64