Struct BinaryViewVectorMut 

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

A mutable vector of binary view data.

The immutable equivalent of this type is BinaryViewVector.

Implementations

impl<T: BinaryViewType> BinaryViewVectorMut<T>

pub fn new( views: BufferMut<BinaryView>, buffers: Vec<ByteBuffer>, validity: MaskMut, ) -> Self

Create a new BinaryViewVectorMut 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 with_capacity(capacity: usize) -> Self

Create a new empty BinaryViewVectorMut, pre-allocated to hold the specified number of items. This does not reserve any memory for string data itself, only for the binary views and the validity bits.

pub fn try_new( views: BufferMut<BinaryView>, buffers: Vec<ByteBuffer>, validity: MaskMut, ) -> VortexResult<Self>

Tries to create a new BinaryViewVectorMut from its components.

Errors

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

Returns an error if the views reference any data that is not a valid buffer

pub unsafe fn new_unchecked( views: BufferMut<BinaryView>, validity: MaskMut, buffers: Vec<ByteBuffer>, ) -> Self

Creates a new BinaryViewVectorMut from the given bits and validity mask without validation.

Safety

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

pub unsafe fn views_mut(&mut self) -> &mut BufferMut<BinaryView>

Get a mutable handle to the buffer holding the views of the vector.

Safety

Caller must make sure that length of the views always matches length of the validity mask.

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

Get a mutable handle to the validity mask of the vector.

Safety

Caller must make sure that the length of the validity mask always matches the length of the views

pub fn buffers(&mut self) -> &mut Vec<ByteBuffer>

Get a mutable handle to the vector of buffers backing the string data of the vector.

pub fn append_values(&mut self, value: &T::Slice, n: usize)

Append a repeated sequence of binary data to a vector.

let mut strings = StringVectorMut::with_capacity(4);
strings.append_values("inlined", 2);
strings.append_nulls(1);
strings.append_values("large not inlined", 1);

let strings = strings.freeze();

assert_eq!(
    [strings.get_ref(0), strings.get_ref(1), strings.get_ref(2), strings.get_ref(3)],
    [Some("inlined"), Some("inlined"), None, Some("large not inlined")],
);

pub fn append_owned_values(&mut self, value: T::Scalar, n: usize)

Append a repeated sequence of binary data to a vector, from an owned buffer.

The buffer will be used directly if possible, avoiding a copy.

Trait Implementations

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

fn clone(&self) -> BinaryViewVectorMut<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 BinaryViewVectorMut<T>

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<T: BinaryViewType> VectorMutOps for BinaryViewVectorMut<T>

type Immutable = BinaryViewVector<T>

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: &BinaryViewVector<T>)

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) -> BinaryViewVector<T>

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.