Struct PrimitiveArray

pub struct PrimitiveArray { /* private fields */ }

Implementations

impl PrimitiveArray

pub fn patch(self, patches: &Patches) -> VortexResult<Self>

impl PrimitiveArray

pub fn top_value(&self) -> VortexResult<Option<(PValue, usize)>>

Compute most common present value of this array

impl PrimitiveArray

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

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

pub fn from_byte_buffer( buffer: ByteBuffer, ptype: PType, validity: Validity, ) -> Self

pub fn from_option_iter<T: NativePType, I: IntoIterator<Item = Option<T>>>( iter: I, ) -> Self

Create a PrimitiveArray from an iterator of T. NOTE: we cannot impl FromIterator trait since it conflicts with FromIterator<T>.

pub fn ptype(&self) -> PType

pub fn byte_buffer(&self) -> &ByteBuffer

pub fn into_byte_buffer(self) -> ByteBuffer

pub fn buffer<T: NativePType>(&self) -> Buffer<T>

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

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

Extract a mutable buffer from the PrimitiveArray. 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: NativePType>( self, ) -> Result<BufferMut<T>, PrimitiveArray>

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

pub fn map_each<T, R, F>(self, f: F) -> PrimitiveArray

where T: NativePType, R: NativePType, F: FnMut(T) -> R,

Map each element in the array to a new value.

This ignores validity and maps over all maybe-null elements.

TODO(ngates): we could be smarter here if validity is sparse and only run the function over the valid elements.

pub fn map_each_with_validity<T, R, F>( self, f: F, ) -> VortexResult<PrimitiveArray>

where T: NativePType, R: NativePType, F: FnMut((T, bool)) -> R,

Map each element in the array to a new value.

This doesn’t ignore validity and maps over all maybe-null elements, with a bool true if valid and false otherwise.

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

Return a slice of the array’s buffer.

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

pub fn reinterpret_cast(&self, ptype: PType) -> Self

Methods from Deref<Target = dyn Array>

pub fn is_constant(&self) -> bool

pub fn is_constant_opts(&self, cost: Cost) -> bool

pub fn as_constant(&self) -> Option<Scalar>

pub fn as_<V: VTable>(&self) -> &V::Array

Returns the array downcast to the given A.

pub fn as_opt<V: VTable>(&self) -> Option<&V::Array>

Returns the array downcast to the given A.

pub fn is<V: VTable>(&self) -> bool

Is self an array with encoding from vtable V.

pub fn nbytes(&self) -> usize

Total size of the array in bytes, including all children and buffers.

pub fn to_array_iterator(&self) -> impl ArrayIterator + 'static

Create an ArrayIterator over the array.

pub fn serialize( &self, ctx: &ArrayContext, options: &SerializeOptions, ) -> VortexResult<Vec<ByteBuffer>>

Serialize the array into a sequence of byte buffers that should be written contiguously. This function returns a vec to avoid copying data buffers.

Optionally, padding can be included to guarantee buffer alignment and ensure zero-copy reads within the context of an external file or stream. In this case, the alignment of the first byte buffer should be respected when writing the buffers to the stream or file.

The format of this blob is a sequence of data buffers, possible with prefixed padding, followed by a flatbuffer containing an fba::Array message, and ending with a little-endian u32 describing the length of the flatbuffer message.

pub fn to_array_stream(&self) -> impl ArrayStream + 'static

Create an ArrayStream over the array.

pub fn tree_display(&self) -> impl Display

pub fn as_null_typed(&self) -> NullTyped<'_>

Downcasts the array for null-specific behavior.

pub fn as_bool_typed(&self) -> BoolTyped<'_>

Downcasts the array for bool-specific behavior.

pub fn as_primitive_typed(&self) -> PrimitiveTyped<'_>

Downcasts the array for primitive-specific behavior.

pub fn as_decimal_typed(&self) -> DecimalTyped<'_>

Downcasts the array for decimal-specific behavior.

pub fn as_utf8_typed(&self) -> Utf8Typed<'_>

Downcasts the array for utf8-specific behavior.

pub fn as_binary_typed(&self) -> BinaryTyped<'_>

Downcasts the array for binary-specific behavior.

pub fn as_struct_typed(&self) -> StructTyped<'_>

Downcasts the array for struct-specific behavior.

pub fn as_list_typed(&self) -> ListTyped<'_>

Downcasts the array for list-specific behavior.

pub fn as_extension_typed(&self) -> ExtensionTyped<'_>

Downcasts the array for extension-specific behavior.

Trait Implementations

impl<T: NativePType> ArrayAccessor<T> for PrimitiveArray

fn with_iterator<F, R>(&self, f: F) -> VortexResult<R>

where F: for<'a> FnOnce(&mut dyn Iterator<Item = Option<&'a T>>) -> R,

Iterate over each element of the array, in-order.

impl AsRef<dyn Array> for PrimitiveArray

fn as_ref(&self) -> &dyn Array

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for PrimitiveArray

fn clone(&self) -> PrimitiveArray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PrimitiveArray

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

Formats the value using the given formatter.

impl Deref for PrimitiveArray

type Target = dyn Array

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: NativePType> FromIterator<T> for PrimitiveArray

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl IntoArray for PrimitiveArray

fn into_array(self) -> ArrayRef

impl ValidityHelper for PrimitiveArray

fn validity(&self) -> &Validity