Struct FSSTArray

pub struct FSSTArray { /* private fields */ }

Implementations

impl FSSTArray

pub fn try_new( dtype: DType, symbols: Buffer<Symbol>, symbol_lengths: Buffer<u8>, codes: VarBinArray, uncompressed_lengths: ArrayRef, ) -> VortexResult<Self>

Build an FSST array from a set of symbols and codes.

Symbols are 8-bytes and can represent short strings, each of which is assigned a code.

The codes array is a Binary array where each binary datum is a sequence of 8-bit codes. Each code corresponds either to a symbol, or to the “escape code”, which tells the decoder to emit the following byte without doing a table lookup.

pub fn symbols(&self) -> &Buffer<Symbol>

Access the symbol table array

pub fn symbol_lengths(&self) -> &Buffer<u8>

Access the symbol table array

pub fn codes(&self) -> &VarBinArray

Access the codes array

pub fn codes_dtype(&self) -> &DType

Get the DType of the codes array

pub fn uncompressed_lengths(&self) -> &ArrayRef

Get the uncompressed length for each element in the array.

pub fn uncompressed_lengths_dtype(&self) -> &DType

Get the DType of the uncompressed lengths array

Trait Implementations

impl AsRef<dyn Array> for FSSTArray

fn as_ref(&self) -> &dyn Array

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

impl Clone for FSSTArray

fn clone(&self) -> FSSTArray

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FSSTArray

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

Formats the value using the given formatter.

impl Deref for FSSTArray

type Target = dyn Array

The resulting type after dereferencing.

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

Dereferences the value.

impl IntoArray for FSSTArray

fn into_array(self) -> ArrayRef