Struct DictArray

pub struct DictArray { /* private fields */ }

Implementations

impl DictArray

pub unsafe fn new_unchecked(codes: ArrayRef, values: ArrayRef) -> Self

Build a new DictArray without validating the codes or values.

Safety

This should be called only when you can guarantee the invariants checked by the safe DictArray::try_new constructor are valid, for example when you are filtering or slicing an existing valid DictArray.

pub fn new(codes: ArrayRef, values: ArrayRef) -> Self

Build a new DictArray from its components, codes and values.

This constructor will panic if codes or values do not pass validation for building a new DictArray. See DictArray::try_new for a description of the error conditions.

pub fn try_new(codes: ArrayRef, values: ArrayRef) -> VortexResult<Self>

Build a new DictArray from its components, codes and values.

The codes must be unsigned integers, and may be nullable. Values can be any type, and may also be nullable. This mirrors the nullability of the Arrow DictionaryArray.

Errors

The codes must be unsigned integers, and the maximum code must be less than the length of the values array. Otherwise, this constructor returns an error.

It is an error to provide a nullable codes with non-nullable values.

pub fn codes(&self) -> &ArrayRef

pub fn values(&self) -> &ArrayRef

Trait Implementations

impl AsRef<dyn Array> for DictArray

fn as_ref(&self) -> &dyn Array

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

impl Clone for DictArray

fn clone(&self) -> DictArray

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DictArray

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

Formats the value using the given formatter.

impl Deref for DictArray

type Target = dyn Array

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<DictArray> for ArrayRef

fn from(value: DictArray) -> ArrayRef

Converts to this type from the input type.

impl IntoArray for DictArray

fn into_array(self) -> ArrayRef