Struct PVector 

pub struct PVector<T> { /* private fields */ }

An immutable vector of generic primitive values.

T is expected to be bound by NativePType, which templates an internal Buffer<T> that stores the elements of the vector.

Implementations

impl<T> PVector<T>

pub fn new(elements: Buffer<T>, validity: Mask) -> Self

Creates a new PVector<T> from the given elements buffer and validity mask.

Panics

Panics if the length of the validity mask does not match the length of the elements buffer.

pub fn try_new(elements: Buffer<T>, validity: Mask) -> VortexResult<Self>

Tries to create a new PVector<T> from the given elements buffer and validity mask.

Errors

Returns an error if the length of the validity mask does not match the length of the elements buffer.

pub unsafe fn new_unchecked(elements: Buffer<T>, validity: Mask) -> Self

Creates a new PVector<T> from the given elements buffer and validity mask without validation.

Safety

The caller must ensure that the validity mask has the same length as the elements buffer.

pub fn into_parts(self) -> (Buffer<T>, Mask)

Decomposes the primitive vector into its constituent parts (buffer and validity).

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

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: T.

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 elements(&self) -> &Buffer<T>

Returns the internal Buffer of the PVector.

Note that the internal buffer may hold garbage data in place of nulls. That information is tracked by the validity().

Trait Implementations

impl<T: NativePType> AsRef<[T]> for PVector<T>

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

Returns an immutable slice over the internal buffer with elements of type T.

Note that this slice may contain garbage data where the validity() mask states that an element is invalid.

The caller should check the validity() before performing any operations.

impl<T: Clone> Clone for PVector<T>

fn clone(&self) -> PVector<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for PVector<T>

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

Formats the value using the given formatter.

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

fn from(v: PVector<T>) -> 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<T: NativePType> VectorOps for PVector<T>

fn try_into_mut(self) -> Result<PVectorMut<T>, Self>

Try to convert self into a mutable vector.

type Mutable = PVectorMut<T>

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 into_mut(self) -> PVectorMut<T>

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.