Enum VectorMut 

pub enum VectorMut {
    Null(NullVectorMut),
    Bool(BoolVectorMut),
    Decimal(DecimalVectorMut),
    Primitive(PrimitiveVectorMut),
    String(StringVectorMut),
    Binary(BinaryVectorMut),
    List(ListViewVectorMut),
    FixedSizeList(FixedSizeListVectorMut),
    Struct(StructVectorMut),
}

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

Most of the behavior of VectorMut is described by the VectorMutOps 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 immutable equivalent of this type is Vector, which implements the VectorOps trait.

Variants

Null(NullVectorMut)

Mutable Null vectors.

Bool(BoolVectorMut)

Mutable Boolean vectors.

Decimal(DecimalVectorMut)

Mutable Decimal vectors.

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

See the documentation for more information.

Primitive(PrimitiveVectorMut)

Mutable Primitive vectors.

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

See the documentation for more information.

String(StringVectorMut)

Mutable String vectors.

Binary(BinaryVectorMut)

Mutable Binary vectors.

List(ListViewVectorMut)

Mutable vectors of Lists with variable sizes.

FixedSizeList(FixedSizeListVectorMut)

Mutable vectors of Lists with fixed sizes.

Struct(StructVectorMut)

Mutable vectors of Struct elements.

Implementations

impl VectorMut

pub fn with_capacity(dtype: &DType, capacity: usize) -> Self

Create a new mutable vector with the given capacity and dtype.

impl VectorMut

pub fn as_null_mut(&mut self) -> &mut NullVectorMut

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

pub fn as_bool_mut(&mut self) -> &mut BoolVectorMut

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

pub fn as_primitive_mut(&mut self) -> &mut PrimitiveVectorMut

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

pub fn as_string_mut(&mut self) -> &mut StringVectorMut

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

pub fn as_binary_mut(&mut self) -> &mut BinaryVectorMut

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

pub fn as_list_mut(&mut self) -> &mut ListViewVectorMut

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

pub fn as_fixed_size_list_mut(&mut self) -> &mut FixedSizeListVectorMut

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

pub fn as_struct_mut(&mut self) -> &mut StructVectorMut

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

pub fn into_null(self) -> NullVectorMut

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

pub fn into_bool(self) -> BoolVectorMut

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

pub fn into_primitive(self) -> PrimitiveVectorMut

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

pub fn into_string(self) -> StringVectorMut

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

pub fn into_binary(self) -> BinaryVectorMut

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

pub fn into_list(self) -> ListViewVectorMut

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

pub fn into_fixed_size_list(self) -> FixedSizeListVectorMut

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

pub fn into_struct(self) -> StructVectorMut

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

Trait Implementations

impl BinaryViewDowncast for VectorMut

type Output<T: BinaryViewType> = BinaryViewVectorMut<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 VectorMut

type Input<T: BinaryViewType> = BinaryViewVectorMut<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 VectorMut

fn clone(&self) -> VectorMut

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VectorMut

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

Formats the value using the given formatter.

impl<T: BinaryViewType> From<BinaryViewVectorMut<T>> for VectorMut

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

Converts to this type from the input type.

impl From<BoolVectorMut> for VectorMut

fn from(v: BoolVectorMut) -> Self

Converts to this type from the input type.

impl<D: NativeDecimalType> From<DVectorMut<D>> for VectorMut

fn from(val: DVectorMut<D>) -> Self

Converts to this type from the input type.

impl From<DecimalVectorMut> for VectorMut

fn from(v: DecimalVectorMut) -> Self

Converts to this type from the input type.

impl From<FixedSizeListVectorMut> for VectorMut

fn from(v: FixedSizeListVectorMut) -> Self

Converts to this type from the input type.

impl From<ListViewVectorMut> for VectorMut

fn from(v: ListViewVectorMut) -> Self

Converts to this type from the input type.

impl From<NullVectorMut> for VectorMut

fn from(v: NullVectorMut) -> Self

Converts to this type from the input type.

impl<T: NativePType> From<PVectorMut<T>> for VectorMut

fn from(val: PVectorMut<T>) -> Self

Converts to this type from the input type.

impl From<PrimitiveVectorMut> for VectorMut

fn from(v: PrimitiveVectorMut) -> Self

Converts to this type from the input type.

impl From<StructVectorMut> for VectorMut

fn from(v: StructVectorMut) -> Self

Converts to this type from the input type.

impl VectorMutOps for VectorMut

type Immutable = Vector

The immutable equivalent of this mutable vector.

fn len(&self) -> usize

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

fn validity(&self) -> &MaskMut

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

fn capacity(&self) -> usize

Returns the total number of elements the vector can hold without reallocating.

fn reserve(&mut self, additional: usize)

Reserves capacity for at least additional more elements to be inserted in the given vector.

fn clear(&mut self)

Clears the buffer, removing all data. Existing capacity is preserved.

fn truncate(&mut self, len: usize)

Shortens the buffer, keeping the first len bytes and dropping the rest.

fn extend_from_vector(&mut self, other: &Vector)

Extends the vector by appending elements from another vector.

fn append_nulls(&mut self, n: usize)

Appends n null elements to the vector.

fn freeze(self) -> Vector

Converts self into an immutable vector.

fn split_off(&mut self, at: usize) -> Self

Splits the vector into two at the given index.

fn unsplit(&mut self, other: Self)

Absorbs a mutable vector that was previously split off.

fn is_empty(&self) -> bool

Returns true if the vector contains no elements.