Struct PrimitiveData 

pub struct PrimitiveData { /* private fields */ }

A primitive array that stores native types in a contiguous buffer of memory, along with an optional validity child.

This mirrors the Apache Arrow Primitive layout and can be converted into and out of one without allocations or copies.

The underlying buffer must be natively aligned to the primitive type they are representing.

Values are stored in their native representation with proper alignment. Null values still occupy space in the buffer but are marked invalid in the validity mask.

Examples

use vortex_array::arrays::PrimitiveArray;
use vortex_array::{LEGACY_SESSION, VortexSessionExecute};

// Create from iterator using FromIterator impl
let array: PrimitiveArray = [1i32, 2, 3, 4, 5].into_iter().collect();

// Slice the array
let sliced = array.slice(1..3)?;

// Access individual values
let mut ctx = LEGACY_SESSION.create_execution_ctx();
let value = sliced.execute_scalar(0, &mut ctx).unwrap();
assert_eq!(value, 2i32.into());

Implementations

impl PrimitiveData

pub fn as_slice<T>(&self) -> &[T]

where T: NativePType,

Return a slice of the array’s buffer.

NOTE: these values may be nonsense if the validity buffer indicates that the value is null.

Panic

This operation will panic if the array is not backed by host memory.

impl PrimitiveData

pub unsafe fn new_unchecked_from_handle( handle: BufferHandle, ptype: PType, _validity: Validity, ) -> PrimitiveData

Create a new array from a buffer handle.

Safety

Should ensure that the provided BufferHandle points at sufficiently large region of aligned memory to hold the ptype values.

pub fn new<T>(buffer: impl Into<Buffer<T>>, validity: Validity) -> PrimitiveData

where T: NativePType,

Creates a new PrimitiveArray.

Panics

Panics if the provided components do not satisfy the invariants documented in PrimitiveArray::new_unchecked.

pub fn try_new<T>( buffer: Buffer<T>, validity: Validity, ) -> Result<PrimitiveData, VortexError>

where T: NativePType,

Constructs a new PrimitiveArray.

See PrimitiveArray::new_unchecked for more information.

Errors

Returns an error if the provided components do not satisfy the invariants documented in PrimitiveArray::new_unchecked.

pub unsafe fn new_unchecked<T>( buffer: Buffer<T>, _validity: Validity, ) -> PrimitiveData

where T: NativePType,

Creates a new PrimitiveArray without validation from these components:

• buffer is a typed buffer containing the primitive values.
• validity holds the null values.

Safety

The caller must ensure all of the following invariants are satisfied:

Validity Requirements

• If validity is Validity::Array, its length must exactly equal buffer.len().

pub fn validate<T>( buffer: &Buffer<T>, validity: &Validity, ) -> Result<(), VortexError>

where T: NativePType,

Validates the components that would be used to create a PrimitiveArray.

This function checks all the invariants required by PrimitiveArray::new_unchecked.

pub fn empty<T>(nullability: Nullability) -> PrimitiveData

where T: NativePType,

impl PrimitiveData

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

Returns true if the array is empty.

pub fn ptype(&self) -> PType

pub fn buffer_handle(&self) -> &BufferHandle

Get access to the buffer handle backing the array.

pub fn from_buffer_handle( handle: BufferHandle, ptype: PType, _validity: Validity, ) -> PrimitiveData

pub fn from_byte_buffer( buffer: Buffer<u8>, ptype: PType, validity: Validity, ) -> PrimitiveData

pub fn from_values_byte_buffer( valid_elems_buffer: Buffer<u8>, ptype: PType, validity: Validity, n_rows: usize, ) -> PrimitiveData

Create a PrimitiveArray from a byte buffer containing only the valid elements.

pub fn to_buffer<T>(&self) -> Buffer<T>

where T: NativePType,

Get a buffer in host memory holding all the values.

NOTE: some values may be nonsense if the validity buffer indicates that the value is null.

pub fn into_buffer<T>(self) -> Buffer<T>

where T: NativePType,

Consume the array and get a host Buffer containing the data values.

pub fn into_buffer_mut<T>(self) -> BufferMut<T>

where T: NativePType,

Extract a mutable buffer from the PrimitiveData. Attempts to do this with zero-copy if the buffer is uniquely owned, otherwise will make a copy.

pub fn try_into_buffer_mut<T>(self) -> Result<BufferMut<T>, Buffer<T>>

where T: NativePType,

Try to extract a mutable buffer from the PrimitiveData with zero copy.

Trait Implementations

impl ArrayEq for PrimitiveData

fn array_eq(&self, other: &PrimitiveData, precision: Precision) -> bool

impl ArrayHash for PrimitiveData

fn array_hash<H>(&self, state: &mut H, precision: Precision)

where H: Hasher,

impl Clone for PrimitiveData

fn clone(&self) -> PrimitiveData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PrimitiveData

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

Formats the value using the given formatter.

impl Display for PrimitiveData

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

Formats the value using the given formatter.