Trait arrow_array::array::Array

source ·
pub trait Array: Debug + Send + Sync {
Show 14 methods // Required methods fn as_any(&self) -> &dyn Any; fn to_data(&self) -> ArrayData; fn into_data(self) -> ArrayData; fn data_type(&self) -> &DataType; fn slice(&self, offset: usize, length: usize) -> ArrayRef; fn len(&self) -> usize; fn is_empty(&self) -> bool; fn offset(&self) -> usize; fn nulls(&self) -> Option<&NullBuffer>; fn get_buffer_memory_size(&self) -> usize; fn get_array_memory_size(&self) -> usize; // Provided methods fn is_null(&self, index: usize) -> bool { ... } fn is_valid(&self, index: usize) -> bool { ... } fn null_count(&self) -> usize { ... }
}
Expand description

An array in the arrow columnar format

Required Methods§

source

fn as_any(&self) -> &dyn Any

Returns the array as Any so that it can be downcasted to a specific implementation.

Example:

let id = Int32Array::from(vec![1, 2, 3, 4, 5]);
let batch = RecordBatch::try_new(
    Arc::new(Schema::new(vec![Field::new("id", DataType::Int32, false)])),
    vec![Arc::new(id)]
).unwrap();

let int32array = batch
    .column(0)
    .as_any()
    .downcast_ref::<Int32Array>()
    .expect("Failed to downcast");
source

fn to_data(&self) -> ArrayData

Returns the underlying data of this array

source

fn into_data(self) -> ArrayData

Returns the underlying data of this array

Unlike Array::to_data this consumes self, allowing it avoid unnecessary clones

source

fn data_type(&self) -> &DataType

Returns a reference to the DataType of this array.

Example:
use arrow_schema::DataType;
use arrow_array::{Array, Int32Array};

let array = Int32Array::from(vec![1, 2, 3, 4, 5]);

assert_eq!(*array.data_type(), DataType::Int32);
source

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

Returns a zero-copy slice of this array with the indicated offset and length.

Example:
use arrow_array::{Array, Int32Array};

let array = Int32Array::from(vec![1, 2, 3, 4, 5]);
// Make slice over the values [2, 3, 4]
let array_slice = array.slice(1, 3);

assert_eq!(&array_slice, &Int32Array::from(vec![2, 3, 4]));
source

fn len(&self) -> usize

Returns the length (i.e., number of elements) of this array.

Example:
use arrow_array::{Array, Int32Array};

let array = Int32Array::from(vec![1, 2, 3, 4, 5]);

assert_eq!(array.len(), 5);
source

fn is_empty(&self) -> bool

Returns whether this array is empty.

Example:
use arrow_array::{Array, Int32Array};

let array = Int32Array::from(vec![1, 2, 3, 4, 5]);

assert_eq!(array.is_empty(), false);
source

fn offset(&self) -> usize

Returns the offset into the underlying data used by this array(-slice). Note that the underlying data can be shared by many arrays. This defaults to 0.

Example:
use arrow_array::{Array, BooleanArray};

let array = BooleanArray::from(vec![false, false, true, true]);
let array_slice = array.slice(1, 3);

assert_eq!(array.offset(), 0);
assert_eq!(array_slice.offset(), 1);
source

fn nulls(&self) -> Option<&NullBuffer>

Returns the null buffers of this array if any

source

fn get_buffer_memory_size(&self) -> usize

Returns the total number of bytes of memory pointed to by this array. The buffers store bytes in the Arrow memory format, and include the data as well as the validity map.

source

fn get_array_memory_size(&self) -> usize

Returns the total number of bytes of memory occupied physically by this array. This value will always be greater than returned by get_buffer_memory_size() and includes the overhead of the data structures that contain the pointers to the various buffers.

Provided Methods§

source

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

Returns whether the element at index is null. When using this function on a slice, the index is relative to the slice.

Example:
use arrow_array::{Array, Int32Array};

let array = Int32Array::from(vec![Some(1), None]);

assert_eq!(array.is_null(0), false);
assert_eq!(array.is_null(1), true);
source

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

Returns whether the element at index is not null. When using this function on a slice, the index is relative to the slice.

Example:
use arrow_array::{Array, Int32Array};

let array = Int32Array::from(vec![Some(1), None]);

assert_eq!(array.is_valid(0), true);
assert_eq!(array.is_valid(1), false);
source

fn null_count(&self) -> usize

Returns the total number of null values in this array.

Example:
use arrow_array::{Array, Int32Array};

// Construct an array with values [1, NULL, NULL]
let array = Int32Array::from(vec![Some(1), None, None]);

assert_eq!(array.null_count(), 2);

Trait Implementations§

source§

impl AsArray for dyn Array + '_

source§

fn as_boolean_opt(&self) -> Option<&BooleanArray>

Downcast this to a BooleanArray returning None if not possible
source§

fn as_primitive_opt<T: ArrowPrimitiveType>(&self) -> Option<&PrimitiveArray<T>>

Downcast this to a PrimitiveArray returning None if not possible
source§

fn as_bytes_opt<T: ByteArrayType>(&self) -> Option<&GenericByteArray<T>>

Downcast this to a GenericByteArray returning None if not possible
source§

fn as_struct_opt(&self) -> Option<&StructArray>

Downcast this to a StructArray returning None if not possible
source§

fn as_list_opt<O: OffsetSizeTrait>(&self) -> Option<&GenericListArray<O>>

Downcast this to a GenericListArray returning None if not possible
source§

fn as_fixed_size_list_opt(&self) -> Option<&FixedSizeListArray>

Downcast this to a FixedSizeListArray returning None if not possible
source§

fn as_map_opt(&self) -> Option<&MapArray>

Downcast this to a MapArray returning None if not possible
source§

fn as_dictionary_opt<K: ArrowDictionaryKeyType>( &self ) -> Option<&DictionaryArray<K>>

Downcast this to a DictionaryArray returning None if not possible
source§

fn as_boolean(&self) -> &BooleanArray

Downcast this to a BooleanArray panicking if not possible
source§

fn as_primitive<T: ArrowPrimitiveType>(&self) -> &PrimitiveArray<T>

Downcast this to a PrimitiveArray panicking if not possible
source§

fn as_bytes<T: ByteArrayType>(&self) -> &GenericByteArray<T>

Downcast this to a GenericByteArray panicking if not possible
source§

fn as_string_opt<O: OffsetSizeTrait>(&self) -> Option<&GenericStringArray<O>>

Downcast this to a GenericStringArray returning None if not possible
source§

fn as_string<O: OffsetSizeTrait>(&self) -> &GenericStringArray<O>

Downcast this to a GenericStringArray panicking if not possible
source§

fn as_binary_opt<O: OffsetSizeTrait>(&self) -> Option<&GenericBinaryArray<O>>

Downcast this to a GenericBinaryArray returning None if not possible
source§

fn as_binary<O: OffsetSizeTrait>(&self) -> &GenericBinaryArray<O>

Downcast this to a GenericBinaryArray panicking if not possible
source§

fn as_struct(&self) -> &StructArray

Downcast this to a StructArray panicking if not possible
source§

fn as_list<O: OffsetSizeTrait>(&self) -> &GenericListArray<O>

Downcast this to a GenericListArray panicking if not possible
source§

fn as_fixed_size_list(&self) -> &FixedSizeListArray

Downcast this to a FixedSizeListArray panicking if not possible
source§

fn as_map(&self) -> &MapArray

Downcast this to a MapArray panicking if not possible
source§

fn as_dictionary<K: ArrowDictionaryKeyType>(&self) -> &DictionaryArray<K>

Downcast this to a DictionaryArray panicking if not possible
source§

impl<T: Array> PartialEq<T> for dyn Array + '_

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<dyn Array + '_> for dyn Array + '_

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

Implementations on Foreign Types§

source§

impl<'a, T: Array> Array for &'a T

source§

fn as_any(&self) -> &dyn Any

source§

fn to_data(&self) -> ArrayData

source§

fn into_data(self) -> ArrayData

source§

fn data_type(&self) -> &DataType

source§

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

source§

fn len(&self) -> usize

source§

fn is_empty(&self) -> bool

source§

fn offset(&self) -> usize

source§

fn nulls(&self) -> Option<&NullBuffer>

source§

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

source§

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

source§

fn null_count(&self) -> usize

source§

fn get_buffer_memory_size(&self) -> usize

source§

fn get_array_memory_size(&self) -> usize

Implementors§