Struct DVectorMut 

pub struct DVectorMut<D> { /* private fields */ }

A mutable vector of decimal values with fixed precision and scale.

D is bound by NativeDecimalType, which can be one of the native integer types (i8, i16, i32, i64, i128) or i256. D is used to store the decimal values.

The decimal vector maintains a PrecisionScale<D> that defines the precision (total number of digits) and scale (digits after the decimal point) for all values in the vector.

Unlike primitive vectors, decimal vectors require validation during construction and modification to ensure values stay within the bounds defined by their precision and scale. This makes operations like “push” fallible, thus we have a try_push() method instead.

Implementations

impl<D: NativeDecimalType> DVectorMut<D>

pub fn new( ps: PrecisionScale<D>, elements: BufferMut<D>, validity: MaskMut, ) -> Self

Creates a new DVectorMut<D> from the given PrecisionScale, elements buffer, and validity mask.

Panics

Panics if:

• The lengths of the elements and validity do not match.
• Any of the elements are out of bounds for the given PrecisionScale.

pub fn try_new( ps: PrecisionScale<D>, elements: BufferMut<D>, validity: MaskMut, ) -> VortexResult<Self>

Tries to create a new DVectorMut<D> from the given PrecisionScale, elements buffer, and validity mask.

Errors

Returns an error if:

• The lengths of the elements and validity do not match.
• Any of the elements are out of bounds for the given PrecisionScale.

pub unsafe fn new_unchecked( ps: PrecisionScale<D>, elements: BufferMut<D>, validity: MaskMut, ) -> Self

Creates a new DVectorMut<D> from the given PrecisionScale, elements buffer, and validity mask, without validation.

Safety

The caller must ensure:

• The lengths of the elements and validity are equal.
• All elements are in bounds for the given PrecisionScale.

pub fn with_capacity(ps: PrecisionScale<D>, capacity: usize) -> Self

Create a new mutable primitive vector with the given capacity.

pub fn into_parts(self) -> (PrecisionScale<D>, BufferMut<D>, MaskMut)

Decomposes the decimal vector into its constituent parts (PrecisionScale, decimal buffer, and validity).

pub fn precision_scale(&self) -> PrecisionScale<D>

Get the precision/scale of the decimal vector.

pub fn elements(&self) -> &BufferMut<D>

Returns a reference to the underlying elements buffer containing the decimal data.

pub unsafe fn elements_mut(&mut self) -> &mut BufferMut<D>

Returns a mutable reference to the underlying elements buffer containing the decimal data.

Safety

Modifying the elements buffer directly may violate the precision/scale constraints. The caller must ensure that any modifications maintain these invariants.

pub unsafe fn validity_mut(&mut self) -> &mut MaskMut

Returns a mutable reference to the underlying validity mask of the vector.

Safety

The caller must ensure that when the length of the validity changes, the length of the elements is changed to match it.

pub fn get(&self, index: usize) -> Option<&D>

Gets a nullable element at the given index, panicking on out-of-bounds.

If the element at the given index is null, returns None. Otherwise, returns Some(x), where x: D.

Note that this get method is different from the standard library slice::get, which returns None if the index is out of bounds. This method will panic if the index is out of bounds, and return None if the elements is null.

Panics

Panics if the index is out of bounds.

pub fn try_push(&mut self, value: D) -> VortexResult<()>

Appends a new element to the end of the vector.

Errors

Returns an error if the value is out of bounds for the vector’s precision/scale.

pub fn try_append_n(&mut self, value: D, n: usize) -> VortexResult<()>

Appends n elements to the vector, all set to the given value.

Errors

Returns an error if the value is out of bounds for the vector’s precision/scale.

Trait Implementations

impl<D: NativeDecimalType> AsRef<[D]> for DVectorMut<D>

fn as_ref(&self) -> &[D]

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

impl<D: Clone> Clone for DVectorMut<D>

fn clone(&self) -> DVectorMut<D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<D: Debug> Debug for DVectorMut<D>

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

Formats the value using the given formatter.

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

fn from(val: DVectorMut<D>) -> 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<D: NativeDecimalType> VectorMutOps for DVectorMut<D>

type Immutable = DVector<D>

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: &DVector<D>)

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) -> DVector<D>

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.