Enum Vector 

pub enum Vector {
    Null(NullVector),
    Bool(BoolVector),
    Decimal(DecimalVector),
    Primitive(PrimitiveVector),
    String(StringVector),
    Binary(BinaryVector),
    List(ListViewVector),
    FixedSizeList(FixedSizeListVector),
    Struct(StructVector),
}

An enum over all kinds of immutable vectors, which represent fully decompressed (canonical) array data.

Most of the behavior of Vector is described by the VectorOps trait. Note that vectors are always considered as nullable, and it is the responsibility of the user to not add any nullable data to a vector they want to keep as non-nullable.

The mutable equivalent of this type is VectorMut, which implements the VectorMutOps trait.

Variants

Null(NullVector)

Null vectors.

Bool(BoolVector)

Boolean vectors.

Decimal(DecimalVector)

Decimal vectors.

Note that DecimalVector is an enum over the different possible (generic) DVector<D>s.

See the documentation for more information.

Primitive(PrimitiveVector)

Primitive vectors.

Note that PrimitiveVector is an enum over the different possible (generic) PVector<T>s.

See the documentation for more information.

String(StringVector)

String vectors

Binary(BinaryVector)

Binary vectors

List(ListViewVector)

Vectors of Lists with variable sizes.

FixedSizeList(FixedSizeListVector)

Vectors of Lists with fixed sizes.

Struct(StructVector)

Vectors of Struct elements.

Implementations

impl Vector

pub fn as_null(&self) -> &NullVector

Returns a reference to the inner NullVector if self is of that variant.

pub fn as_bool(&self) -> &BoolVector

Returns a reference to the inner BoolVector if self is of that variant.

pub fn as_primitive(&self) -> &PrimitiveVector

Returns a reference to the inner PrimitiveVector if self is of that variant.

pub fn as_string(&self) -> &StringVector

Returns a reference to the inner StringVector if self is of that variant.

pub fn as_binary(&self) -> &BinaryVector

Returns a reference to the inner BinaryVector if self is of that variant.

pub fn as_list(&self) -> &ListViewVector

Returns a reference to the inner ListViewVector if self is of that variant.

pub fn as_fixed_size_list(&self) -> &FixedSizeListVector

Returns a reference to the inner FixedSizeListVector if self is of that variant.

pub fn as_struct(&self) -> &StructVector

Returns a reference to the inner StructVector if self is of that variant.

pub fn into_null(self) -> NullVector

Consumes self and returns the inner NullVector if self is of that variant.

pub fn into_bool(self) -> BoolVector

Consumes self and returns the inner BoolVector if self is of that variant.

pub fn into_primitive(self) -> PrimitiveVector

Consumes self and returns the inner PrimitiveVector if self is of that variant.

pub fn into_decimal(self) -> DecimalVector

Consumes self and returns the inner DecimalVector if self is of that variant.

pub fn into_string(self) -> StringVector

Consumes self and returns the inner StringVector if self is of that variant.

pub fn into_binary(self) -> BinaryVector

Consumes self and returns the inner BinaryVector if self is of that variant.

pub fn into_list(self) -> ListViewVector

Consumes self and returns the inner ListViewVector if self is of that variant.

pub fn into_fixed_size_list(self) -> FixedSizeListVector

Consumes self and returns the inner FixedSizeListVector if self is of that variant.

pub fn into_struct(self) -> StructVector

Consumes self and returns the inner StructVector if self is of that variant.

Trait Implementations

impl BinaryViewDowncast for Vector

type Output<T: BinaryViewType> = BinaryViewVector<T>

The output type after downcasting.

fn into_binary(self) -> Self::Output<BinaryType>

Downcast to a binary type.

fn into_string(self) -> Self::Output<StringType>

Downcast to a string type.

impl BinaryViewTypeUpcast for Vector

type Input<T: BinaryViewType> = BinaryViewVector<T>

The input type for upcasting.

fn from_binary(input: Self::Input<BinaryType>) -> Self

Upcast from a binary type.

fn from_string(input: Self::Input<StringType>) -> Self

Upcast from a string type.

impl Clone for Vector

fn clone(&self) -> Vector

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Vector

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

Formats the value using the given formatter.

impl<T: BinaryViewType> From<BinaryViewVector<T>> for Vector

fn from(value: BinaryViewVector<T>) -> Self

Converts to this type from the input type.

impl From<BoolVector> for Vector

fn from(v: BoolVector) -> Self

Converts to this type from the input type.

impl<D: NativeDecimalType> From<DVector<D>> for Vector

fn from(v: DVector<D>) -> Self

Converts to this type from the input type.

impl From<DecimalVector> for Vector

fn from(v: DecimalVector) -> Self

Converts to this type from the input type.

impl From<FixedSizeListVector> for Vector

fn from(v: FixedSizeListVector) -> Self

Converts to this type from the input type.

impl From<ListViewVector> for Vector

fn from(v: ListViewVector) -> Self

Converts to this type from the input type.

impl From<NullVector> for Vector

fn from(v: NullVector) -> Self

Converts to this type from the input type.

impl<T: NativePType> From<PVector<T>> for Vector

fn from(v: PVector<T>) -> Self

Converts to this type from the input type.

impl From<PrimitiveVector> for Vector

fn from(v: PrimitiveVector) -> Self

Converts to this type from the input type.

impl From<StructVector> for Vector

fn from(v: StructVector) -> Self

Converts to this type from the input type.

impl VectorOps for Vector

type Mutable = VectorMut

The mutable equivalent of this immutable vector.

fn len(&self) -> usize

Returns the number of elements in the vector, also referred to as its “length”.

fn validity(&self) -> &Mask

Returns the validity mask of the vector, where true represents a valid element and false represents a null element.

fn scalar_at(&self, index: usize) -> Scalar

Return the scalar at the given index.

fn slice(&self, range: impl RangeBounds<usize> + Clone + Debug) -> Self

Slice the vector from start to end (exclusive).

fn try_into_mut(self) -> Result<VectorMut, Self>

Tries to convert self into a mutable vector (implementing VectorMutOps).

fn into_mut(self) -> VectorMut

Converts self into a mutable vector (implementing VectorMutOps).

fn is_empty(&self) -> bool

Returns true if the vector contains no elements.

fn null_count(&self) -> usize

Returns the null count of the vector.