Struct BinaryViewVector 

pub struct BinaryViewVector<T: BinaryViewType> { /* private fields */ }

A variable-length binary vector.

This is the core vector for string and binary data.

Implementations

impl<T: BinaryViewType> BinaryViewVector<T>

pub unsafe fn new_unchecked( views: Buffer<BinaryView>, buffers: Arc<Box<[ByteBuffer]>>, validity: Mask, ) -> Self

Creates a new BinaryViewVector from the provided components.

Safety

This function is unsafe because it does not validate the consistency of the provided components.

The caller must uphold all validation that would otherwise be validated by the safe constructor.

pub fn new( views: Buffer<BinaryView>, buffers: Arc<Box<[ByteBuffer]>>, validity: Mask, ) -> Self

Create a new BinaryViewVector from its components, panicking if validation fails.

Errors

This function will panic if any of the validation checks performed by try_new fails.

pub fn try_new( views: Buffer<BinaryView>, buffers: Arc<Box<[ByteBuffer]>>, validity: Mask, ) -> VortexResult<Self>

Create a new BinaryViewVector from the provided components with validation.

Errors

This function will return an error if any of the following validation checks fails:

1. The length of the views does not match the length of the provided validity
2. Any non-null views point to invalid buffers or buffer offset ranges
3. Any data stored inlined or in the buffers and referenced by the views does not conform to the validation constraints of this view type.

pub fn into_parts(self) -> (Buffer<BinaryView>, Arc<Box<[ByteBuffer]>>, Mask)

Decomposes the vector into its constituent parts.

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

Get the index item from the vector as an owned Scalar type with zero-copy.

This function will panic is index is out of range for the vector’s length.

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

Get the index item from the vector as a native Slice type.

This function will panic is index is out of range for the vector’s length.

pub fn buffers(&self) -> &Arc<Box<[ByteBuffer]>>

Buffers

pub fn views(&self) -> &Buffer<BinaryView>

Views

Trait Implementations

impl<T: Clone + BinaryViewType> Clone for BinaryViewVector<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + BinaryViewType> Debug for BinaryViewVector<T>

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<T: BinaryViewType> VectorOps for BinaryViewVector<T>

type Mutable = BinaryViewVectorMut<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 try_into_mut(self) -> Result<BinaryViewVectorMut<T>, Self>

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

fn into_mut(self) -> BinaryViewVectorMut<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.