Struct arrow::array::PrimitiveArray

pub struct PrimitiveArray<T: ArrowPrimitiveType> { /* fields omitted */ }

Array whose elements are of primitive types.

Implementations

impl<T: ArrowPrimitiveType> PrimitiveArray<T>

pub fn len(&self) -> usize

Returns the length of this array.

pub fn is_empty(&self) -> bool

Returns whether this array is empty.

pub fn values(&self) -> &[T::Native]

Returns a slice of the values of this array

pub fn builder(capacity: usize) -> PrimitiveBuilder<T>

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

Returns the primitive value at index i.

Safety

caller must ensure that the passed in offset is less than the array len()

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

Returns the primitive value at index i.

Note this doesn’t do any bound checking, for performance reason.

Safety

caller must ensure that the passed in offset is less than the array len()

pub fn from_iter_values<I: IntoIterator<Item = T::Native>>(iter: I) -> Self

Creates a PrimitiveArray based on an iterator of values without nulls

pub fn from_value(value: T::Native, count: usize) -> Self

Creates a PrimitiveArray based on a constant value with count elements

impl<T: ArrowTemporalType + ArrowNumericType> PrimitiveArray<T> where
    i64: From<T::Native>, 

pub fn value_as_datetime(&self, i: usize) -> Option<NaiveDateTime>

Returns value as a chrono NaiveDateTime, handling time resolution

If a data type cannot be converted to NaiveDateTime, a None is returned. A valid value is expected, thus the user should first check for validity.

pub fn value_as_date(&self, i: usize) -> Option<NaiveDate>

Returns value as a chrono NaiveDate by using Self::datetime()

If a data type cannot be converted to NaiveDate, a None is returned

pub fn value_as_time(&self, i: usize) -> Option<NaiveTime>

Returns a value as a chrono NaiveTime

Date32 and Date64 return UTC midnight as they do not have time resolution

pub fn value_as_duration(&self, i: usize) -> Option<Duration>

Returns a value as a chrono Duration

If a data type cannot be converted to Duration, a None is returned

impl<'a, T: ArrowPrimitiveType> PrimitiveArray<T>

pub fn iter(&'a self) -> PrimitiveIter<'a, T>

constructs a new iterator

impl<T: ArrowPrimitiveType> PrimitiveArray<T>

pub unsafe fn from_trusted_len_iter<I, P>(iter: I) -> Self where
    P: Borrow<Option<<T as ArrowPrimitiveType>::Native>>,
    I: IntoIterator<Item = P>, 

Creates a PrimitiveArray from an iterator of trusted length.

Safety

The iterator must be TrustedLen. I.e. that size_hint().1 correctly reports its length.

impl<T: ArrowTimestampType> PrimitiveArray<T>

pub fn from_vec(data: Vec<i64>, timezone: Option<String>) -> Self

Construct a timestamp array from a vec of i64 values and an optional timezone

impl<T: ArrowTimestampType> PrimitiveArray<T>

pub fn from_opt_vec(data: Vec<Option<i64>>, timezone: Option<String>) -> Self

Construct a timestamp array from a vec of Option values and an optional timezone

Trait Implementations

impl<T: ArrowPrimitiveType> Array for PrimitiveArray<T>

fn as_any(&self) -> &dyn Any

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

fn data(&self) -> &ArrayData

Returns a reference to the underlying data of this array.

fn get_buffer_memory_size(&self) -> usize

Returns the total number of bytes of memory occupied by the buffers owned by this PrimitiveArray.

fn get_array_memory_size(&self) -> usize

Returns the total number of bytes of memory occupied physically by this PrimitiveArray.

fn data_ref(&self) -> &ArrayData

Returns a reference-counted pointer to the underlying data of this array.

fn data_type(&self) -> &DataType

Returns a reference to the DataType of this array.

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

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

fn len(&self) -> usize

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

fn is_empty(&self) -> bool

Returns whether this array is empty.

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.

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.

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.

fn null_count(&self) -> usize

Returns the total number of null values in this array.

fn to_raw(&self) -> Result<(*const FFI_ArrowArray, *const FFI_ArrowSchema)>

returns two pointers that represent this array in the C Data Interface (FFI)

impl<T: ArrowPrimitiveType> Debug for PrimitiveArray<T>

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

Formats the value using the given formatter.

impl<T: ArrowPrimitiveType> From<ArrayData> for PrimitiveArray<T>

Constructs a PrimitiveArray from an array data reference.

fn from(data: ArrayData) -> Self

Performs the conversion.

impl From<Vec<<Date32Type as ArrowPrimitiveType>::Native, Global>> for PrimitiveArray<Date32Type>

fn from(data: Vec<<Date32Type as ArrowPrimitiveType>::Native>) -> Self

Performs the conversion.

impl From<Vec<<Date64Type as ArrowPrimitiveType>::Native, Global>> for PrimitiveArray<Date64Type>

fn from(data: Vec<<Date64Type as ArrowPrimitiveType>::Native>) -> Self

Performs the conversion.

impl From<Vec<<DurationMicrosecondType as ArrowPrimitiveType>::Native, Global>> for PrimitiveArray<DurationMicrosecondType>

fn from(
    data: Vec<<DurationMicrosecondType as ArrowPrimitiveType>::Native>
) -> Self

Performs the conversion.

impl From<Vec<<DurationMillisecondType as ArrowPrimitiveType>::Native, Global>> for PrimitiveArray<DurationMillisecondType>

fn from(
    data: Vec<<DurationMillisecondType as ArrowPrimitiveType>::Native>
) -> Self

Performs the conversion.

impl From<Vec<<DurationNanosecondType as ArrowPrimitiveType>::Native, Global>> for PrimitiveArray<DurationNanosecondType>

fn from(
    data: Vec<<DurationNanosecondType as ArrowPrimitiveType>::Native>
) -> Self

Performs the conversion.

impl From<Vec<<DurationSecondType as ArrowPrimitiveType>::Native, Global>> for PrimitiveArray<DurationSecondType>

fn from(data: Vec<<DurationSecondType as ArrowPrimitiveType>::Native>) -> Self

Performs the conversion.

impl From<Vec<<Float32Type as ArrowPrimitiveType>::Native, Global>> for PrimitiveArray<Float32Type>

fn from(data: Vec<<Float32Type as ArrowPrimitiveType>::Native>) -> Self

Performs the conversion.

impl From<Vec<<Float64Type as ArrowPrimitiveType>::Native, Global>> for PrimitiveArray<Float64Type>

fn from(data: Vec<<Float64Type as ArrowPrimitiveType>::Native>) -> Self

Performs the conversion.

impl From<Vec<<Int16Type as ArrowPrimitiveType>::Native, Global>> for PrimitiveArray<Int16Type>

fn from(data: Vec<<Int16Type as ArrowPrimitiveType>::Native>) -> Self

Performs the conversion.

impl From<Vec<<Int32Type as ArrowPrimitiveType>::Native, Global>> for PrimitiveArray<Int32Type>

fn from(data: Vec<<Int32Type as ArrowPrimitiveType>::Native>) -> Self

Performs the conversion.

impl From<Vec<<Int64Type as ArrowPrimitiveType>::Native, Global>> for PrimitiveArray<Int64Type>

fn from(data: Vec<<Int64Type as ArrowPrimitiveType>::Native>) -> Self

Performs the conversion.

impl From<Vec<<Int8Type as ArrowPrimitiveType>::Native, Global>> for PrimitiveArray<Int8Type>

fn from(data: Vec<<Int8Type as ArrowPrimitiveType>::Native>) -> Self

Performs the conversion.

impl From<Vec<<IntervalDayTimeType as ArrowPrimitiveType>::Native, Global>> for PrimitiveArray<IntervalDayTimeType>

fn from(data: Vec<<IntervalDayTimeType as ArrowPrimitiveType>::Native>) -> Self

Performs the conversion.

impl From<Vec<<IntervalYearMonthType as ArrowPrimitiveType>::Native, Global>> for PrimitiveArray<IntervalYearMonthType>

fn from(
    data: Vec<<IntervalYearMonthType as ArrowPrimitiveType>::Native>
) -> Self

Performs the conversion.

impl From<Vec<<Time32MillisecondType as ArrowPrimitiveType>::Native, Global>> for PrimitiveArray<Time32MillisecondType>

fn from(
    data: Vec<<Time32MillisecondType as ArrowPrimitiveType>::Native>
) -> Self

Performs the conversion.

impl From<Vec<<Time32SecondType as ArrowPrimitiveType>::Native, Global>> for PrimitiveArray<Time32SecondType>

fn from(data: Vec<<Time32SecondType as ArrowPrimitiveType>::Native>) -> Self

Performs the conversion.

impl From<Vec<<Time64MicrosecondType as ArrowPrimitiveType>::Native, Global>> for PrimitiveArray<Time64MicrosecondType>

fn from(
    data: Vec<<Time64MicrosecondType as ArrowPrimitiveType>::Native>
) -> Self

Performs the conversion.

impl From<Vec<<Time64NanosecondType as ArrowPrimitiveType>::Native, Global>> for PrimitiveArray<Time64NanosecondType>

fn from(data: Vec<<Time64NanosecondType as ArrowPrimitiveType>::Native>) -> Self

Performs the conversion.

impl From<Vec<<TimestampMicrosecondType as ArrowPrimitiveType>::Native, Global>> for PrimitiveArray<TimestampMicrosecondType>

fn from(
    data: Vec<<TimestampMicrosecondType as ArrowPrimitiveType>::Native>
) -> Self

Performs the conversion.

impl From<Vec<<TimestampMillisecondType as ArrowPrimitiveType>::Native, Global>> for PrimitiveArray<TimestampMillisecondType>

fn from(
    data: Vec<<TimestampMillisecondType as ArrowPrimitiveType>::Native>
) -> Self

Performs the conversion.

impl From<Vec<<TimestampNanosecondType as ArrowPrimitiveType>::Native, Global>> for PrimitiveArray<TimestampNanosecondType>

fn from(
    data: Vec<<TimestampNanosecondType as ArrowPrimitiveType>::Native>
) -> Self

Performs the conversion.

impl From<Vec<<TimestampSecondType as ArrowPrimitiveType>::Native, Global>> for PrimitiveArray<TimestampSecondType>

fn from(data: Vec<<TimestampSecondType as ArrowPrimitiveType>::Native>) -> Self

Performs the conversion.

impl From<Vec<<UInt16Type as ArrowPrimitiveType>::Native, Global>> for PrimitiveArray<UInt16Type>

fn from(data: Vec<<UInt16Type as ArrowPrimitiveType>::Native>) -> Self

Performs the conversion.

impl From<Vec<<UInt32Type as ArrowPrimitiveType>::Native, Global>> for PrimitiveArray<UInt32Type>

fn from(data: Vec<<UInt32Type as ArrowPrimitiveType>::Native>) -> Self

Performs the conversion.

impl From<Vec<<UInt64Type as ArrowPrimitiveType>::Native, Global>> for PrimitiveArray<UInt64Type>

fn from(data: Vec<<UInt64Type as ArrowPrimitiveType>::Native>) -> Self

Performs the conversion.

impl From<Vec<<UInt8Type as ArrowPrimitiveType>::Native, Global>> for PrimitiveArray<UInt8Type>

fn from(data: Vec<<UInt8Type as ArrowPrimitiveType>::Native>) -> Self

Performs the conversion.

impl From<Vec<Option<<Date32Type as ArrowPrimitiveType>::Native>, Global>> for PrimitiveArray<Date32Type>

fn from(data: Vec<Option<<Date32Type as ArrowPrimitiveType>::Native>>) -> Self

Performs the conversion.

impl From<Vec<Option<<Date64Type as ArrowPrimitiveType>::Native>, Global>> for PrimitiveArray<Date64Type>

fn from(data: Vec<Option<<Date64Type as ArrowPrimitiveType>::Native>>) -> Self

Performs the conversion.

impl From<Vec<Option<<DurationMicrosecondType as ArrowPrimitiveType>::Native>, Global>> for PrimitiveArray<DurationMicrosecondType>

fn from(
    data: Vec<Option<<DurationMicrosecondType as ArrowPrimitiveType>::Native>>
) -> Self

Performs the conversion.

impl From<Vec<Option<<DurationMillisecondType as ArrowPrimitiveType>::Native>, Global>> for PrimitiveArray<DurationMillisecondType>

fn from(
    data: Vec<Option<<DurationMillisecondType as ArrowPrimitiveType>::Native>>
) -> Self

Performs the conversion.

impl From<Vec<Option<<DurationNanosecondType as ArrowPrimitiveType>::Native>, Global>> for PrimitiveArray<DurationNanosecondType>

fn from(
    data: Vec<Option<<DurationNanosecondType as ArrowPrimitiveType>::Native>>
) -> Self

Performs the conversion.

impl From<Vec<Option<<DurationSecondType as ArrowPrimitiveType>::Native>, Global>> for PrimitiveArray<DurationSecondType>

fn from(
    data: Vec<Option<<DurationSecondType as ArrowPrimitiveType>::Native>>
) -> Self

Performs the conversion.

impl From<Vec<Option<<Float32Type as ArrowPrimitiveType>::Native>, Global>> for PrimitiveArray<Float32Type>

fn from(data: Vec<Option<<Float32Type as ArrowPrimitiveType>::Native>>) -> Self

Performs the conversion.

impl From<Vec<Option<<Float64Type as ArrowPrimitiveType>::Native>, Global>> for PrimitiveArray<Float64Type>

fn from(data: Vec<Option<<Float64Type as ArrowPrimitiveType>::Native>>) -> Self

Performs the conversion.

impl From<Vec<Option<<Int16Type as ArrowPrimitiveType>::Native>, Global>> for PrimitiveArray<Int16Type>

fn from(data: Vec<Option<<Int16Type as ArrowPrimitiveType>::Native>>) -> Self

Performs the conversion.

impl From<Vec<Option<<Int32Type as ArrowPrimitiveType>::Native>, Global>> for PrimitiveArray<Int32Type>

fn from(data: Vec<Option<<Int32Type as ArrowPrimitiveType>::Native>>) -> Self

Performs the conversion.

impl From<Vec<Option<<Int64Type as ArrowPrimitiveType>::Native>, Global>> for PrimitiveArray<Int64Type>

fn from(data: Vec<Option<<Int64Type as ArrowPrimitiveType>::Native>>) -> Self

Performs the conversion.

impl From<Vec<Option<<Int8Type as ArrowPrimitiveType>::Native>, Global>> for PrimitiveArray<Int8Type>

fn from(data: Vec<Option<<Int8Type as ArrowPrimitiveType>::Native>>) -> Self

Performs the conversion.

impl From<Vec<Option<<IntervalDayTimeType as ArrowPrimitiveType>::Native>, Global>> for PrimitiveArray<IntervalDayTimeType>

fn from(
    data: Vec<Option<<IntervalDayTimeType as ArrowPrimitiveType>::Native>>
) -> Self

Performs the conversion.

impl From<Vec<Option<<IntervalYearMonthType as ArrowPrimitiveType>::Native>, Global>> for PrimitiveArray<IntervalYearMonthType>

fn from(
    data: Vec<Option<<IntervalYearMonthType as ArrowPrimitiveType>::Native>>
) -> Self

Performs the conversion.

impl From<Vec<Option<<Time32MillisecondType as ArrowPrimitiveType>::Native>, Global>> for PrimitiveArray<Time32MillisecondType>

fn from(
    data: Vec<Option<<Time32MillisecondType as ArrowPrimitiveType>::Native>>
) -> Self

Performs the conversion.

impl From<Vec<Option<<Time32SecondType as ArrowPrimitiveType>::Native>, Global>> for PrimitiveArray<Time32SecondType>

fn from(
    data: Vec<Option<<Time32SecondType as ArrowPrimitiveType>::Native>>
) -> Self

Performs the conversion.

impl From<Vec<Option<<Time64MicrosecondType as ArrowPrimitiveType>::Native>, Global>> for PrimitiveArray<Time64MicrosecondType>

fn from(
    data: Vec<Option<<Time64MicrosecondType as ArrowPrimitiveType>::Native>>
) -> Self

Performs the conversion.

impl From<Vec<Option<<Time64NanosecondType as ArrowPrimitiveType>::Native>, Global>> for PrimitiveArray<Time64NanosecondType>

fn from(
    data: Vec<Option<<Time64NanosecondType as ArrowPrimitiveType>::Native>>
) -> Self

Performs the conversion.

impl From<Vec<Option<<TimestampMicrosecondType as ArrowPrimitiveType>::Native>, Global>> for PrimitiveArray<TimestampMicrosecondType>

fn from(
    data: Vec<Option<<TimestampMicrosecondType as ArrowPrimitiveType>::Native>>
) -> Self

Performs the conversion.

impl From<Vec<Option<<TimestampMillisecondType as ArrowPrimitiveType>::Native>, Global>> for PrimitiveArray<TimestampMillisecondType>

fn from(
    data: Vec<Option<<TimestampMillisecondType as ArrowPrimitiveType>::Native>>
) -> Self

Performs the conversion.

impl From<Vec<Option<<TimestampNanosecondType as ArrowPrimitiveType>::Native>, Global>> for PrimitiveArray<TimestampNanosecondType>

fn from(
    data: Vec<Option<<TimestampNanosecondType as ArrowPrimitiveType>::Native>>
) -> Self

Performs the conversion.

impl From<Vec<Option<<TimestampSecondType as ArrowPrimitiveType>::Native>, Global>> for PrimitiveArray<TimestampSecondType>

fn from(
    data: Vec<Option<<TimestampSecondType as ArrowPrimitiveType>::Native>>
) -> Self

Performs the conversion.

impl From<Vec<Option<<UInt16Type as ArrowPrimitiveType>::Native>, Global>> for PrimitiveArray<UInt16Type>

fn from(data: Vec<Option<<UInt16Type as ArrowPrimitiveType>::Native>>) -> Self

Performs the conversion.

impl From<Vec<Option<<UInt32Type as ArrowPrimitiveType>::Native>, Global>> for PrimitiveArray<UInt32Type>

fn from(data: Vec<Option<<UInt32Type as ArrowPrimitiveType>::Native>>) -> Self

Performs the conversion.

impl From<Vec<Option<<UInt64Type as ArrowPrimitiveType>::Native>, Global>> for PrimitiveArray<UInt64Type>

fn from(data: Vec<Option<<UInt64Type as ArrowPrimitiveType>::Native>>) -> Self

Performs the conversion.

impl From<Vec<Option<<UInt8Type as ArrowPrimitiveType>::Native>, Global>> for PrimitiveArray<UInt8Type>

fn from(data: Vec<Option<<UInt8Type as ArrowPrimitiveType>::Native>>) -> Self

Performs the conversion.

impl<T: ArrowPrimitiveType, Ptr: Borrow<Option<<T as ArrowPrimitiveType>::Native>>> FromIterator<Ptr> for PrimitiveArray<T>

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

Creates a value from an iterator.

impl<'a, T: ArrowPrimitiveType> IntoIterator for &'a PrimitiveArray<T>

type Item = Option<<T as ArrowPrimitiveType>::Native>

The type of the elements being iterated over.

type IntoIter = PrimitiveIter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: ArrowPrimitiveType> JsonEqual for PrimitiveArray<T>

Implement array equals for numeric type

fn equals_json(&self, json: &[&Value]) -> bool

Checks whether arrow array equals to json array.

fn equals_json_values(&self, json: &[Value]) -> bool

Checks whether arrow array equals to json array.

impl<T: ArrowPrimitiveType> PartialEq<PrimitiveArray<T>> for PrimitiveArray<T>

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

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

#[must_use]

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

This method tests for !=.

impl<T: ArrowPrimitiveType> PartialEq<Value> for PrimitiveArray<T>

fn eq(&self, json: &Value) -> bool

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

#[must_use]

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

This method tests for !=.