arrow_array::array

Struct TypedRunArray

Source
pub struct TypedRunArray<'a, R: RunEndIndexType, V> { /* private fields */ }
Expand description

A RunArray typed typed on its child values array

Implements ArrayAccessor and IntoIterator allowing fast access to its elements

use arrow_array::{RunArray, StringArray, types::Int32Type};

let orig = ["a", "b", "a", "b"];
let ree_array = RunArray::<Int32Type>::from_iter(orig);

// `TypedRunArray` allows you to access the values directly
let typed = ree_array.downcast::<StringArray>().unwrap();

for (maybe_val, orig) in typed.into_iter().zip(orig) {
    assert_eq!(maybe_val.unwrap(), orig)
}

Implementations§

Source§

impl<'a, R: RunEndIndexType, V> TypedRunArray<'a, R, V>

Source

pub fn run_ends(&self) -> &'a RunEndBuffer<R::Native>

Returns the run_ends of this TypedRunArray

Source

pub fn values(&self) -> &'a V

Returns the values of this TypedRunArray

Source

pub fn run_array(&self) -> &'a RunArray<R>

Returns the run array of this TypedRunArray

Trait Implementations§

Source§

impl<'a, R: RunEndIndexType, V: Sync> Array for TypedRunArray<'a, R, V>

Source§

fn as_any(&self) -> &dyn Any

Returns the array as Any so that it can be downcasted to a specific implementation. Read more
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 Read more
Source§

fn data_type(&self) -> &DataType

Returns a reference to the DataType of this array. Read more
Source§

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

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

fn len(&self) -> usize

Returns the length (i.e., number of elements) of this array. Read more
Source§

fn is_empty(&self) -> bool

Returns whether this array is empty. Read more
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. Read more
Source§

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

Returns the null buffer of this array if any. Read more
Source§

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

Returns a potentially computed NullBuffer that represents the logical null values of this array, if any. Read more
Source§

fn is_nullable(&self) -> bool

Returns false if the array is guaranteed to not contain any logical nulls Read more
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. Note that this does not always correspond to the exact memory usage of an array, since multiple arrays can share the same buffers or slices thereof.
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.
Source§

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

Returns whether the element at index is null according to Array::nulls Read more
Source§

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

Returns whether the element at index is not null, the opposite of Self::is_null. Read more
Source§

fn null_count(&self) -> usize

Returns the total number of physical null values in this array. Read more
Source§

impl<'a, R, V> ArrayAccessor for TypedRunArray<'a, R, V>

Source§

type Item = <&'a V as ArrayAccessor>::Item

The Arrow type of the element being accessed.
Source§

fn value(&self, logical_index: usize) -> Self::Item

Returns the element at index i Read more
Source§

unsafe fn value_unchecked(&self, logical_index: usize) -> Self::Item

Returns the element at index i Read more
Source§

impl<'a, R: RunEndIndexType, V> Clone for TypedRunArray<'a, R, V>

Source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<'a, R: RunEndIndexType, V> Debug for TypedRunArray<'a, R, V>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'a, R, V> IntoIterator for TypedRunArray<'a, R, V>

Source§

type Item = Option<<&'a V as ArrayAccessor>::Item>

The type of the elements being iterated over.
Source§

type IntoIter = RunArrayIter<'a, R, V>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl<'a, R: RunEndIndexType, V> Copy for TypedRunArray<'a, R, V>

Auto Trait Implementations§

§

impl<'a, R, V> Freeze for TypedRunArray<'a, R, V>

§

impl<'a, R, V> !RefUnwindSafe for TypedRunArray<'a, R, V>

§

impl<'a, R, V> Send for TypedRunArray<'a, R, V>
where V: Sync,

§

impl<'a, R, V> Sync for TypedRunArray<'a, R, V>
where V: Sync,

§

impl<'a, R, V> Unpin for TypedRunArray<'a, R, V>

§

impl<'a, R, V> !UnwindSafe for TypedRunArray<'a, R, V>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> Datum for T
where T: Array,

Source§

fn get(&self) -> (&dyn Array, bool)

Returns the value for this Datum and a boolean indicating if the value is scalar
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.