Module arrow::array

Statically typed implementations of Arrow Arrays

See arrow_array for examples and usage instructions

Structs

• ArrayData
  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.
• ArrayDataBuilder
  Builder for ArrayData type
• ArrayIter
  An iterator that returns Some(T) or None, that can be used on any ArrayAccessor
• BooleanArray
  Array of bools
• BooleanBufferBuilder
  A builder for creating a boolean Buffer
• BooleanBuilder
  Array builder for fixed-width primitive types
• BufferBuilder
  Builder for creating a Buffer object.
• DataTypeLayout
  Layout specification for a data type
• DictionaryArray
  A 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.
• FixedSizeBinaryArray
  An array where each element is a fixed-size sequence of bytes.
• FixedSizeBinaryBuilder
  A fixed size binary array builder
• FixedSizeListArray
  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.
• FixedSizeListBuilder
  Array builder for FixedSizeListArray
• GenericByteArray
  Generic struct for variable-size byte arrays
• GenericByteBuilder
  Array builder for GenericByteArray
• GenericByteDictionaryBuilder
  Generic array builder for DictionaryArray that stores generic byte values. 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.
• GenericByteRunBuilder
  Array builder for RunArray for String and Binary types.
• GenericListArray
  Generic struct for a variable-size list array.
• GenericListBuilder
  Array builder for GenericListArrays.
• MapArray
  A nested array type where each record is a key-value map. Keys should always be non-null, but values can be null.
• MapBuilder
  Creates a new MapBuilder
• MapFieldNames
  Contains details of the mapping
• MutableArrayData
  Struct to efficiently and interactively create an ArrayData from an existing ArrayData by copying chunks.
• NativeAdapter
  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.
• NullArray
  An Array where all elements are nulls
• PrimitiveArray
  Array whose elements are of primitive types.
• PrimitiveBuilder
  Array builder for fixed-width primitive types
• PrimitiveDictionaryBuilder
  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.
• PrimitiveRunBuilder
  Array builder for RunArray that encodes primitive values.
• RunArray
  A run-end encoding (REE) is a variation of run-length encoding (RLE).
• StructArray
  A nested array type where each child (called field) is represented by a separate array.
• StructBuilder
  Array builder for Struct types.
• TypedDictionaryArray
  A strongly-typed wrapper around a DictionaryArray that implements ArrayAccessor allowing fast access to its elements
• TypedRunArray
  A strongly-typed wrapper around a RunArray that implements ArrayAccessor and IntoIterator allowing fast access to its elements
• UnionArray
  An Array that can represent slots of varying types.
• UnionBuilder
  Builder type for creating a new UnionArray.

Enums

• BufferSpec
  Layout specification for a single data type buffer
• Capacities
  Define capacities of child data or data buffers.

Traits

• Array
  Trait for dealing with different types of array at runtime when the type of the array is not known in advance.
• ArrayAccessor
  A generic trait for accessing the values of an Array
• ArrayBuilder
  Trait for dealing with different array builders at runtime
• ArrowPrimitiveType
  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.
• AsArray
  An extension trait for dyn Array that provides ergonomic downcasting
• OffsetSizeTrait
  trait declaring an offset size, relevant for i32 vs i64 array types.

Functions

• as_boolean_array
  Force downcast of an Array, such as an ArrayRef to BooleanArray, panic’ing on failure.
• as_decimal_array
  Force downcast of an Array, such as an ArrayRef to Decimal128Array, panic’ing on failure.
• as_dictionary_array
  Force downcast of an Array, such as an ArrayRef to DictionaryArray<T>, panic’ing on failure.
• as_generic_binary_array
  Force downcast of an Array, such as an ArrayRef to GenericBinaryArray<S>, panic’ing on failure.
• as_generic_list_array
  Force downcast of an Array, such as an ArrayRef to GenericListArray<T>, panic’ing on failure.
• as_large_list_array
  Force downcast of an Array, such as an ArrayRef to LargeListArray, panic’ing on failure.
• as_largestring_array
  Force downcast of an Array, such as an ArrayRef to LargeStringArray, panic’ing on failure.
• as_list_array
  Force downcast of an Array, such as an ArrayRef to ListArray, panic’ing on failure.
• as_map_array
  Force downcast of an Array, such as an ArrayRef to MapArray, panic’ing on failure.
• as_null_array
  Force downcast of an Array, such as an ArrayRef to NullArray, panic’ing on failure.
• as_primitive_array
  Force downcast of an Array, such as an ArrayRef, to PrimitiveArray<T>, panic’ing on failure.
• as_run_array
  Force downcast of an Array, such as an ArrayRef to RunArray<T>, panic’ing on failure.
• as_string_array
  Force downcast of an Array, such as an ArrayRef to StringArray, panic’ing on failure.
• as_struct_array
  Force downcast of an Array, such as an ArrayRef to StructArray, panic’ing on failure.
• as_union_array
  Force downcast of an Array, such as an ArrayRef to UnionArray, panic’ing on failure.
• build_compare
  returns a comparison function that compares two values at two different positions between the two arrays. The arrays’ types must be equal.
• downcast_array
  Downcasts a dyn Array to a concrete type
• export_array_into_raw^⚠Deprecated
  Exports an array to raw pointers of the C Data Interface provided by the consumer.
• layout
  Return the expected DataTypeLayout Arrays of this data type are expected to have
• make_array
  Constructs an array using the input data. Returns a reference-counted Array instance.
• make_builder
  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.
• new_empty_array
  Creates a new empty array
• new_null_array
  Creates a new array of data_type of length length filled entirely of NULL values

Type Definitions

• ArrayDataRef
• ArrayRef
  A reference-counted reference to a generic Array.
• BinaryArray
  An array where each element contains 0 or more bytes. The byte length of each element is represented by an i32.
• BinaryBuilder
  A binary array builder with i32 offsets
• BinaryDictionaryBuilder
  Array builder for DictionaryArray that stores binary. For example to map a set of byte indices to binary values. Note that the use of a HashMap here will not scale to very large arrays or result in an ordered dictionary.
• BinaryRunBuilder
  Array builder for RunArray that encodes binary values(BinaryType).
• BooleanIter
  an iterator that returns Some(T) or None, that can be used on any BooleanArray
• Date32Array
  A primitive array where each element is of 32-bit value representing the elapsed time since UNIX epoch in days.“
• Date32BufferBuilder
  Buffer builder for 32-bit date type.
• Date32Builder
  A 32-bit date array builder.
• Date64Array
  A primitive array where each element is a 64-bit value representing the elapsed time since the UNIX epoch in milliseconds.
• Date64BufferBuilder
  Buffer builder for 64-bit date type.
• Date64Builder
  A 64-bit date array builder.
• Decimal128Array
  An array where each element is a 128-bits decimal with precision in [1, 38] and scale less or equal to 38.
• Decimal128Builder
  A decimal 128 array builder
• Decimal256Array
  An array where each element is a 256-bits decimal with precision in [1, 76] and scale less or equal to 76.
• Decimal256Builder
  A decimal 256 array builder
• DurationMicrosecondArray
  An array where each element is an elapsed time type in microseconds.
• DurationMicrosecondBufferBuilder
  Buffer builder for elaspsed time of microseconds unit.
• DurationMicrosecondBuilder
  An elapsed time in microseconds array builder.
• DurationMillisecondArray
  An array where each element is an elapsed time type in milliseconds.
• DurationMillisecondBufferBuilder
  Buffer builder for elaspsed time of milliseconds unit.
• DurationMillisecondBuilder
  An elapsed time in milliseconds array builder.
• DurationNanosecondArray
  An array where each element is an elapsed time type in nanoseconds.
• DurationNanosecondBufferBuilder
  Buffer builder for elaspsed time of nanoseconds unit.
• DurationNanosecondBuilder
  An elapsed time in nanoseconds array builder.
• DurationSecondArray
  An array where each element is an elapsed time type in seconds.
• DurationSecondBufferBuilder
  Buffer builder for elaspsed time of second unit.
• DurationSecondBuilder
  An elapsed time in seconds array builder.
• DynComparator
  Compare the values at two arbitrary indices in two arrays.
• FixedSizeBinaryIter
  an iterator that returns Some(T) or None, that can be used on any FixedSizeBinaryArray
• Float16Array
  Example: Using collect
• Float32Array
  Example: Using collect
• Float32BufferBuilder
  Buffer builder for 32-bit floating point type.
• Float32Builder
  A 32-bit floating point array builder.
• Float64Array
  Example: Using collect
• Float64BufferBuilder
  Buffer builder for 64-bit floating point type.
• Float64Builder
  A 64-bit floating point array builder.
• GenericBinaryArray
  See BinaryArray and LargeBinaryArray for storing binary data.
• GenericBinaryBuilder
  Array builder for GenericBinaryArray
• GenericBinaryIter
  an iterator that returns Some(T) or None, that can be used on any BinaryArray
• GenericListArrayIter
  an iterator that returns Some(T) or None, that can be used on any ListArray
• GenericStringArray
  Generic struct for [Large]StringArray
• GenericStringBuilder
  Array builder for GenericStringArray
• GenericStringIter
  an iterator that returns Some(T) or None, that can be used on any Utf8Array
• Int8Array
  Example: Using collect
• Int8BufferBuilder
  Buffer builder for signed 8-bit integer type.
• Int8Builder
  A signed 8-bit integer array builder.
• Int8DictionaryArray
  A dictionary array where each element is a single value indexed by an integer key.
• Int16Array
  Example: Using collect
• Int16BufferBuilder
  Buffer builder for signed 16-bit integer type.
• Int16Builder
  A signed 16-bit integer array builder.
• Int16DictionaryArray
  A dictionary array where each element is a single value indexed by an integer key.
• Int16RunArray
  A RunArray array where run ends are stored using i16 data type.
• Int32Array
  Example: Using collect
• Int32BufferBuilder
  Buffer builder for signed 32-bit integer type.
• Int32Builder
  A signed 32-bit integer array builder.
• Int32DictionaryArray
  A dictionary array where each element is a single value indexed by an integer key.
• Int32RunArray
  A RunArray array where run ends are stored using i32 data type.
• Int64Array
  Example: Using collect
• Int64BufferBuilder
  Buffer builder for signed 64-bit integer type.
• Int64Builder
  A signed 64-bit integer array builder.
• Int64DictionaryArray
  A dictionary array where each element is a single value indexed by an integer key.
• Int64RunArray
  A RunArray array where run ends are stored using i64 data type.
• IntervalDayTimeArray
  An array where each element is a “calendar” interval days and milliseconds.
• IntervalDayTimeBufferBuilder
  Buffer builder for “calendar” interval in days and milliseconds.
• IntervalDayTimeBuilder
  A “calendar” interval in days and milliseconds array builder.
• IntervalMonthDayNanoArray
  An array where each element is a “calendar” interval in months, days, and nanoseconds.
• IntervalMonthDayNanoBufferBuilder
  Buffer builder “calendar” interval in months, days, and nanoseconds.
• IntervalMonthDayNanoBuilder
  A “calendar” interval in months, days, and nanoseconds array builder.
• IntervalYearMonthArray
  An array where each element is a “calendar” interval in months.
• IntervalYearMonthBufferBuilder
  Buffer builder for “calendar” interval in months.
• IntervalYearMonthBuilder
  A “calendar” interval in months array builder.
• LargeBinaryArray
  An array where each element contains 0 or more bytes. The byte length of each element is represented by an i64.
• LargeBinaryBuilder
  A binary array builder with i64 offsets
• LargeBinaryDictionaryBuilder
  Array builder for DictionaryArray that stores large binary. For example to map a set of byte indices to binary values. Note that the use of a HashMap here will not scale to very large arrays or result in an ordered dictionary.
• LargeBinaryRunBuilder
  Array builder for RunArray that encodes large binary values(LargeBinaryType). See documentation of BinaryRunBuilder for an example.
• LargeListArray
  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.
• LargeListBuilder
  Builder for LargeListArrays (i64 offsets)
• LargeStringArray
  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.
• LargeStringBuilder
  A string array builder with i64 offsets
• LargeStringDictionaryBuilder
  Array builder for DictionaryArray that stores large 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.
• LargeStringRunBuilder
  Array builder for RunArray that encodes large strings (LargeUtf8Type). See StringRunBuilder for an example.
• ListArray
  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.
• ListBuilder
  Builder for ListArrays (i32 offsets)
• PrimitiveIter
  an iterator that returns Some(T) or None, that can be used on any PrimitiveArray
• StringArray
  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.
• StringBuilder
  A string array builder with i32 offsets
• StringDictionaryBuilder
  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.
• StringRunBuilder
  Array builder for RunArray that encodes strings (Utf8Type).
• Time32MillisecondArray
  An array where each element is of 32-bit type representing time elapsed in milliseconds since midnight.
• Time32MillisecondBufferBuilder
  Buffer builder for 32-bit elaspsed time since midnight of millisecond unit.
• Time32MillisecondBuilder
  A 32-bit elaspsed time in milliseconds array builder.
• Time32SecondArray
  An array where each element is of 32-bit type representing time elapsed in seconds since midnight.
• Time32SecondBufferBuilder
  Buffer builder for 32-bit elaspsed time since midnight of second unit.
• Time32SecondBuilder
  A 32-bit elaspsed time in seconds array builder.
• Time64MicrosecondArray
  An array where each element is of 64-bit type representing time elapsed in microseconds since midnight.
• Time64MicrosecondBufferBuilder
  Buffer builder for 64-bit elaspsed time since midnight of microsecond unit.
• Time64MicrosecondBuilder
  A 64-bit elaspsed time in microseconds array builder.
• Time64NanosecondArray
  An array where each element is of 64-bit type representing time elapsed in nanoseconds since midnight.
• Time64NanosecondBufferBuilder
  Buffer builder for 64-bit elaspsed time since midnight of nanosecond unit.
• Time64NanosecondBuilder
  A 64-bit elaspsed time in nanoseconds array builder.
• TimestampMicrosecondArray
  A primitive array where each element is of type TimestampMicrosecondType. See examples for TimestampSecondArray.
• TimestampMicrosecondBufferBuilder
  Buffer builder for timestamp type of microsecond unit.
• TimestampMicrosecondBuilder
  A timestamp microsecond array builder.
• TimestampMillisecondArray
  A primitive array where each element is of type TimestampMillisecondType. See examples for TimestampSecondArray.
• TimestampMillisecondBufferBuilder
  Buffer builder for timestamp type of millisecond unit.
• TimestampMillisecondBuilder
  A timestamp millisecond array builder.
• TimestampNanosecondArray
  A primitive array where each element is of type TimestampNanosecondType. See examples for TimestampSecondArray.
• TimestampNanosecondBufferBuilder
  Buffer builder for timestamp type of nanosecond unit.
• TimestampNanosecondBuilder
  A timestamp nanosecond array builder.
• TimestampSecondArray
  A primitive array where each element is of type TimestampSecondType. See also Timestamp.
• TimestampSecondBufferBuilder
  Buffer builder for timestamp type of second unit.
• TimestampSecondBuilder
  A timestamp second array builder.
• UInt8Array
  Example: Using collect
• UInt8BufferBuilder
  Buffer builder for usigned 8-bit integer type.
• UInt8Builder
  An usigned 8-bit integer array builder.
• UInt8DictionaryArray
  A dictionary array where each element is a single value indexed by an integer key.
• UInt16Array
  Example: Using collect
• UInt16BufferBuilder
  Buffer builder for usigned 16-bit integer type.
• UInt16Builder
  An usigned 16-bit integer array builder.
• UInt16DictionaryArray
  A dictionary array where each element is a single value indexed by an integer key.
• UInt32Array
  Example: Using collect
• UInt32BufferBuilder
  Buffer builder for usigned 32-bit integer type.
• UInt32Builder
  An usigned 32-bit integer array builder.
• UInt32DictionaryArray
  A dictionary array where each element is a single value indexed by an integer key.
• UInt64Array
  Example: Using collect
• UInt64BufferBuilder
  Buffer builder for usigned 64-bit integer type.
• UInt64Builder
  An usigned 64-bit integer array builder.
• UInt64DictionaryArray
  A dictionary array where each element is a single value indexed by an integer key.