Enum vortex :: Array Copy item path

Data(ArrayData)

View(ArrayView)

Implementations§

pub fn child<'a>( &'a self, idx: usize, dtype: &'a DType, len: usize, ) -> Option<Self>

pub fn children(&self) -> Vec<Array>

pub fn nchildren(&self) -> usize

pub fn depth_first_traversal(&self) -> ArrayChildrenIterator ⓘ

pub fn all_buffer_offsets(&self, alignment: usize) -> Vec<u64>

Return the buffer offsets and the total length of all buffers, assuming the given alignment. This includes all child buffers.

pub fn buffer(&self) -> Option<&Buffer>

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

pub fn into_array_iterator(self) -> impl ArrayIterator

pub fn into_array_stream(self) -> impl ArrayStream

impl Array

pub fn with_dyn<R, F>(&self, f: F) -> R
where F: FnMut(&dyn ArrayTrait) -> R,

Trait Implementations§

impl AsArray for Array

fn as_array_ref(&self) -> &Array

impl Clone for Array

fn clone(&self) -> Array

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

impl Debug for Array

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

Formats the value using the given formatter. Read more

impl Display for Array

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

Formats the value using the given formatter. Read more

impl From<Array> for ArrayData

fn from(value: Array) -> ArrayData

Converts to this type from the input type.

impl From<Array> for RecordBatch

fn from(value: Array) -> Self

Converts to this type from the input type.

impl From<ArrayData> for Array

fn from(value: ArrayData) -> Array

Converts to this type from the input type.

impl From<BoolArray> for Array

fn from(value: BoolArray) -> Array

Converts to this type from the input type.

impl From<Canonical> for Array

This conversion is always “free” and should not touch underlying data. All it does is create an owned pointer to the underlying concrete array type.

This combined with the above IntoCanonical impl for Array allows simple two-way conversions between arbitrary Vortex encodings and canonical Arrow-compatible encodings.

fn from(value: Canonical) -> Self

Converts to this type from the input type.

impl From<ChunkedArray> for Array

fn from(value: ChunkedArray) -> Array

Converts to this type from the input type.

impl From<ConstantArray> for Array

fn from(value: ConstantArray) -> Array

Converts to this type from the input type.

impl From<ExtensionArray> for Array

fn from(value: ExtensionArray) -> Array

Converts to this type from the input type.

impl From<NullArray> for Array

fn from(value: NullArray) -> Array

Converts to this type from the input type.

impl From<PrimitiveArray> for Array

fn from(value: PrimitiveArray) -> Array

Converts to this type from the input type.

impl From<RecordBatch> for Array

fn from(value: RecordBatch) -> Self

Converts to this type from the input type.

impl From<SparseArray> for Array

fn from(value: SparseArray) -> Array

Converts to this type from the input type.

impl From<StructArray> for Array

fn from(value: StructArray) -> Array

Converts to this type from the input type.

impl From<TemporalArray> for Array

fn from(value: TemporalArray) -> Self

Converts to this type from the input type.

impl From<VarBinArray> for Array

fn from(value: VarBinArray) -> Array

Converts to this type from the input type.

impl From<VarBinViewArray> for Array

fn from(value: VarBinViewArray) -> Array

Converts to this type from the input type.

impl FromArrowArray<&BooleanArray> for Array

fn from_arrow(value: &ArrowBooleanArray, nullable: bool) -> Self

impl<T: ByteArrayType> FromArrowArray<&GenericByteArray<T>> for Array
where <T as ByteArrayType>::Offset: NativePType,

fn from_arrow(value: &GenericByteArray<T>, nullable: bool) -> Self

impl<T: ByteViewType> FromArrowArray<&GenericByteViewArray<T>> for Array

fn from_arrow(value: &GenericByteViewArray<T>, nullable: bool) -> Self

impl FromArrowArray<&NullArray> for Array

fn from_arrow(value: &ArrowNullArray, nullable: bool) -> Self

impl<T: ArrowPrimitiveType> FromArrowArray<&PrimitiveArray<T>> for Array
where <T as ArrowPrimitiveType>::Native: NativePType,

fn from_arrow(value: &ArrowPrimitiveArray<T>, nullable: bool) -> Self

impl FromArrowArray<&StructArray> for Array

fn from_arrow(value: &ArrowStructArray, nullable: bool) -> Self

impl FromArrowArray<Arc<dyn Array>> for Array

fn from_arrow(array: ArrowArrayRef, nullable: bool) -> Self

impl FromIterator<Array> for ChunkedArray

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

Creates a value from an iterator. Read more

impl IndexOrd<Scalar> for Array

fn index_cmp(&self, idx: usize, elem: &Scalar) -> Option<Ordering>

fn index_lt(&self, idx: usize, elem: &V) -> bool

fn index_le(&self, idx: usize, elem: &V) -> bool

fn index_gt(&self, idx: usize, elem: &V) -> bool

fn index_ge(&self, idx: usize, elem: &V) -> bool

impl IntoCanonical for Array

IntoCanonical implementation for Array.

Canonicalizing an array requires potentially decompressing, so this requires a roundtrip through the array’s internal codec.

fn into_canonical(self) -> VortexResult<Canonical>

impl Len for Array

fn len(&self) -> usize

impl TryFrom<&Array> for BoolArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: &Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Array> for ChunkedArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: &Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Array> for ConstantArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: &Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Array> for ExtensionArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: &Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Array> for NullArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: &Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Array> for PrimitiveArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: &Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Array> for SparseArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: &Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Array> for StructArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: &Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Array> for TemporalArray

fn try_from(value: &Array) -> Result<Self, Self::Error>

Try to specialize a generic Vortex array as a TemporalArray.

§Errors

If the provided Array does not have vortex.ext encoding, an error will be returned.

If the provided Array does not have recognized ExtMetadata corresponding to one of the known TemporalMetadata variants, an error is returned.

type Error = VortexError

The type returned in the event of a conversion error.

impl<'a, D: ArrayDef> TryFrom<&'a Array> for TypedArray<D>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &'a Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Array> for VarBinArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: &Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Array> for VarBinViewArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: &Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for BoolArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for ChunkedArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for ConstantArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for ExtensionArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for NullArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for PrimitiveArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for SparseArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for StructArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for TemporalArray

fn try_from(value: Array) -> Result<Self, Self::Error>

Try to specialize a generic Vortex array as a TemporalArray.

Delegates to TryFrom<&Array>.

type Error = VortexError

The type returned in the event of a conversion error.

impl<D: ArrayDef> TryFrom<Array> for TypedArray<D>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for VarBinArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for VarBinViewArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: Array) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations§

impl !Freeze for Array

impl !RefUnwindSafe for Array

impl Send for Array

impl Sync for Array

impl Unpin for Array

impl !UnwindSafe for Array

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> ArrayDType for T
where T: AsArray,

fn dtype(&self) -> &DType

impl<T> ArrayEncodingRef for T
where T: AsArray,

fn encoding(&self) -> &'static dyn ArrayEncoding

impl<T> ArrayLen for T
where T: AsArray,

fn len(&self) -> usize

fn is_empty(&self) -> bool

impl<T> ArrayStatistics for T
where T: AsArray,

fn statistics(&self) -> &dyn Statistics

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

default 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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoArrayVariant for T
where T: IntoCanonical,

fn into_null(self) -> Result<NullArray, VortexError>

fn into_bool(self) -> Result<BoolArray, VortexError>

fn into_primitive(self) -> Result<PrimitiveArray, VortexError>

fn into_struct(self) -> Result<StructArray, VortexError>

fn into_varbin(self) -> Result<VarBinArray, VortexError>

fn into_extension(self) -> Result<ExtensionArray, VortexError>

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<S, T> SearchSorted<T> for S
where S: IndexOrd<T> + Len + ?Sized,

fn search_sorted_by<F, N>( &self, find: F, side_find: N, side: SearchSortedSide, ) -> SearchResult
where F: FnMut(usize) -> Ordering, N: FnMut(usize) -> Ordering,

find function is used to find the element if it exists, if element exists side_find will be used to find desired index amongst equal values

fn search_sorted(&self, value: &T, side: SearchSortedSide) -> SearchResult
where Self: IndexOrd<T>,

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

impl<T> ToString for T
where T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.