arrow_array::array::list_view_array

Struct GenericListViewArray

Source
pub struct GenericListViewArray<OffsetSize: OffsetSizeTrait> {
    data_type: DataType,
    nulls: Option<NullBuffer>,
    values: ArrayRef,
    value_offsets: ScalarBuffer<OffsetSize>,
    value_sizes: ScalarBuffer<OffsetSize>,
}
Expand description

Different from crate::GenericListArray as it stores both an offset and length meaning that take / filter operations can be implemented without copying the underlying data.

Fields§

§data_type: DataType§nulls: Option<NullBuffer>§values: ArrayRef§value_offsets: ScalarBuffer<OffsetSize>§value_sizes: ScalarBuffer<OffsetSize>

Implementations§

Source§

impl<OffsetSize: OffsetSizeTrait> GenericListViewArray<OffsetSize>

Source

pub const DATA_TYPE_CONSTRUCTOR: fn(_: FieldRef) -> DataType = _

The data type constructor of listview array. The input is the schema of the child array and the output is the [DataType], ListView or LargeListView.

Source

pub fn try_new( field: FieldRef, offsets: ScalarBuffer<OffsetSize>, sizes: ScalarBuffer<OffsetSize>, values: ArrayRef, nulls: Option<NullBuffer>, ) -> Result<Self, ArrowError>

Create a new GenericListViewArray from the provided parts

§Errors

Errors if

  • offsets.len() != sizes.len()
  • offsets.len() != nulls.len()
  • offsets[i] > values.len()
  • !field.is_nullable() && values.is_nullable()
  • field.data_type() != values.data_type()
  • 0 <= offsets[i] <= length of the child array
  • 0 <= offsets[i] + size[i] <= length of the child array
Source

pub fn new( field: FieldRef, offsets: ScalarBuffer<OffsetSize>, sizes: ScalarBuffer<OffsetSize>, values: ArrayRef, nulls: Option<NullBuffer>, ) -> Self

Create a new GenericListViewArray from the provided parts

§Panics

Panics if Self::try_new returns an error

Source

pub fn new_null(field: FieldRef, len: usize) -> Self

Create a new GenericListViewArray of length len where all values are null

Source

pub fn into_parts( self, ) -> (FieldRef, ScalarBuffer<OffsetSize>, ScalarBuffer<OffsetSize>, ArrayRef, Option<NullBuffer>)

Deconstruct this array into its constituent parts

Source

pub fn offsets(&self) -> &ScalarBuffer<OffsetSize>

Returns a reference to the offsets of this list

Unlike Self::value_offsets this returns the [ScalarBuffer] allowing for zero-copy cloning

Source

pub fn values(&self) -> &ArrayRef

Returns a reference to the values of this list

Source

pub fn sizes(&self) -> &ScalarBuffer<OffsetSize>

Returns a reference to the sizes of this list

Unlike Self::value_sizes this returns the [ScalarBuffer] allowing for zero-copy cloning

Source

pub fn value_type(&self) -> DataType

Returns a clone of the value type of this list.

Source

pub unsafe fn value_unchecked(&self, i: usize) -> ArrayRef

Returns ith value of this list view array.

§Safety

Caller must ensure that the index is within the array bounds

Source

pub fn value(&self, i: usize) -> ArrayRef

Returns ith value of this list view array.

§Panics

Panics if the index is out of bounds

Source

pub fn value_offsets(&self) -> &[OffsetSize]

Returns the offset values in the offsets buffer

Source

pub fn value_sizes(&self) -> &[OffsetSize]

Returns the sizes values in the offsets buffer

Source

pub fn value_size(&self, i: usize) -> OffsetSize

Returns the size for value at index i.

Source

pub fn value_offset(&self, i: usize) -> OffsetSize

Returns the offset for value at index i.

Source

pub fn iter(&self) -> GenericListViewArrayIter<'_, OffsetSize>

Constructs a new iterator

Source

fn get_type(data_type: &DataType) -> Option<&DataType>

Source

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

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

Source§

impl<OffsetSize: OffsetSizeTrait> GenericListViewArray<OffsetSize>

Source

fn try_new_from_array_data(data: ArrayData) -> Result<Self, ArrowError>

Trait Implementations§

Source§

impl<OffsetSize: OffsetSizeTrait> Array for GenericListViewArray<OffsetSize>

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 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 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_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§

fn logical_null_count(&self) -> usize

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

fn is_nullable(&self) -> bool

Returns false if the array is guaranteed to not contain any logical nulls Read more
Source§

impl<OffsetSize: OffsetSizeTrait> ArrayAccessor for &GenericListViewArray<OffsetSize>

Source§

type Item = Arc<dyn Array>

The Arrow type of the element being accessed.
Source§

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

Returns the element at index i Read more
Source§

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

Returns the element at index i Read more
Source§

impl<OffsetSize: Clone + OffsetSizeTrait> Clone for GenericListViewArray<OffsetSize>

Source§

fn clone(&self) -> GenericListViewArray<OffsetSize>

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<OffsetSize: OffsetSizeTrait> Debug for GenericListViewArray<OffsetSize>

Source§

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

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

impl<OffsetSize: OffsetSizeTrait> From<ArrayData> for GenericListViewArray<OffsetSize>

Source§

fn from(data: ArrayData) -> Self

Converts to this type from the input type.
Source§

impl<OffsetSize: OffsetSizeTrait> From<FixedSizeListArray> for GenericListViewArray<OffsetSize>

Source§

fn from(value: FixedSizeListArray) -> Self

Converts to this type from the input type.
Source§

impl<OffsetSize: OffsetSizeTrait> From<GenericListViewArray<OffsetSize>> for ArrayData

Source§

fn from(array: GenericListViewArray<OffsetSize>) -> Self

Converts to this type from the input type.
Source§

impl<OffsetSize: OffsetSizeTrait> PartialEq for GenericListViewArray<OffsetSize>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

Auto Trait Implementations§

§

impl<OffsetSize> Freeze for GenericListViewArray<OffsetSize>

§

impl<OffsetSize> !RefUnwindSafe for GenericListViewArray<OffsetSize>

§

impl<OffsetSize> Send for GenericListViewArray<OffsetSize>

§

impl<OffsetSize> Sync for GenericListViewArray<OffsetSize>

§

impl<OffsetSize> Unpin for GenericListViewArray<OffsetSize>
where OffsetSize: Unpin,

§

impl<OffsetSize> !UnwindSafe for GenericListViewArray<OffsetSize>

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.