Struct VarBinData 

pub struct VarBinData { /* private fields */ }

Implementations

impl VarBinData

pub fn build( offsets: ArrayRef, bytes: ByteBuffer, dtype: DType, validity: Validity, ) -> Self

Creates a new VarBinArray.

Panics

Panics if the provided components do not satisfy the invariants documented in VarBinArray::new_unchecked.

pub fn build_from_handle( offset: ArrayRef, bytes: BufferHandle, dtype: DType, validity: Validity, ) -> Self

Creates a new VarBinArray.

Panics

Panics if the provided components do not satisfy the invariants documented in VarBinArray::new_unchecked.

pub fn try_build( offsets: ArrayRef, bytes: ByteBuffer, dtype: DType, validity: Validity, ) -> VortexResult<Self>

Constructs a new VarBinArray.

See VarBinArray::new_unchecked for more information.

Errors

Returns an error if the provided components do not satisfy the invariants documented in VarBinArray::new_unchecked.

pub fn try_build_from_handle( offsets: ArrayRef, bytes: BufferHandle, dtype: DType, validity: Validity, ) -> VortexResult<Self>

Constructs a new VarBinArray from a BufferHandle of memory that may exist on the CPU or GPU.

See VarBinArray::new_unchecked for more information.

Errors

Returns an error if the provided components do not satisfy the invariants documented in VarBinArray::new_unchecked.

pub unsafe fn new_unchecked(bytes: ByteBuffer) -> Self

Creates a new VarBinArray without validation from these components:

• offsets is an array of byte offsets into the bytes buffer.
• bytes is a buffer containing all the variable-length data concatenated.
• dtype specifies whether this contains UTF-8 strings or binary data.
• validity holds the null values.

Safety

The caller must ensure all of the following invariants are satisfied:

Offsets Requirements

• offsets must be a non-nullable integer array.
• offsets must contain at least 1 element (for empty array, it contains [0]).
• All values in offsets must be monotonically non-decreasing.
• The first value in offsets must be 0.
• No offset value may exceed bytes.len().

Type Requirements

• dtype must be exactly DType::Binary or DType::Utf8.
• If dtype is DType::Utf8, every byte slice bytes[offsets[i]..offsets[i+1]] must be valid UTF-8.
• dtype.is_nullable() must match the nullability of validity.

Validity Requirements

• If validity is Validity::Array, its length must exactly equal offsets.len() - 1.

pub unsafe fn new_unchecked_from_handle(bytes: BufferHandle) -> Self

Creates a new VarBinArray without validation from its components, with string data stored in a BufferHandle (CPU or GPU).

Safety

The caller must ensure all the invariants documented in new_unchecked are satisfied.

pub fn validate( offsets: &ArrayRef, bytes: &BufferHandle, dtype: &DType, validity: &Validity, ) -> VortexResult<()>

Validates the components that would be used to create a VarBinArray.

This function checks all the invariants required by VarBinArray::new_unchecked.

pub fn bytes(&self) -> &ByteBuffer

Access the value bytes child buffer

Note

Bytes child buffer is never sliced when the array is sliced so this can include values that are not logically present in the array. Users should prefer sliced_bytes unless they’re resolving values via the offset child array.

pub fn bytes_handle(&self) -> &BufferHandle

Access the value bytes buffer handle.

Trait Implementations

impl ArrayEq for VarBinData

fn array_eq(&self, other: &Self, precision: Precision) -> bool

impl ArrayHash for VarBinData

fn array_hash<H: Hasher>(&self, state: &mut H, precision: Precision)

impl Clone for VarBinData

fn clone(&self) -> VarBinData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VarBinData

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

Formats the value using the given formatter.

impl Display for VarBinData

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

Formats the value using the given formatter.