Struct FSSTArray

pub struct FSSTArray(/* private fields */);

Implementations

impl FSSTArray

pub fn maybe_from(data: impl AsRef<ArrayData>) -> Option<Self>

Optionally downcast an ArrayData instance to a specific encoding.

Preferred in cases where a backtrace isn’t needed, like when trying multiple encoding to go down different code paths.

impl FSSTArray

pub fn try_new( dtype: DType, symbols: ArrayData, symbol_lengths: ArrayData, codes: ArrayData, uncompressed_lengths: ArrayData, ) -> 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) -> ArrayData

Access the symbol table array

pub fn symbol_lengths(&self) -> ArrayData

Access the symbol table array

pub fn codes(&self) -> ArrayData

Access the codes array

pub fn codes_dtype(&self) -> DType

Get the DType of the codes array

pub fn uncompressed_lengths(&self) -> ArrayData

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

pub fn validity(&self) -> Validity

Get the validity for this array.

Trait Implementations

impl AsRef<ArrayData> for FSSTArray

fn as_ref(&self) -> &ArrayData

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

impl Clone for FSSTArray

fn clone(&self) -> FSSTArray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CompareFn<FSSTArray> for FSSTEncoding

fn compare( &self, lhs: &FSSTArray, rhs: &ArrayData, operator: Operator, ) -> VortexResult<Option<ArrayData>>

Compares two arrays and returns a new boolean array with the result of the comparison. Or, returns None if comparison is not supported for these arrays.

impl Debug for FSSTArray

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

Formats the value using the given formatter.

impl FilterFn<FSSTArray> for FSSTEncoding

fn filter(&self, array: &FSSTArray, mask: FilterMask) -> VortexResult<ArrayData>

Filter an array by the provided predicate.

impl IntoArrayData for FSSTArray

fn into_array(self) -> ArrayData

impl IntoCanonical for FSSTArray

fn into_canonical(self) -> VortexResult<Canonical>

fn into_arrow(self) -> Result<Arc<dyn Array>, VortexError>

where Self: Sized,

impl ScalarAtFn<FSSTArray> for FSSTEncoding

fn scalar_at(&self, array: &FSSTArray, index: usize) -> VortexResult<Scalar>

impl SliceFn<FSSTArray> for FSSTEncoding

fn slice( &self, array: &FSSTArray, start: usize, stop: usize, ) -> VortexResult<ArrayData>

Return a zero-copy slice of an array, between start (inclusive) and end (exclusive). If start >= stop, returns an empty array of the same type as self. Assumes that start or stop are out of bounds, may panic otherwise.

impl StatisticsVTable<FSSTArray> for FSSTEncoding

fn compute_statistics( &self, _array: &Array, _stat: Stat, ) -> Result<StatsSet, VortexError>

Compute the requested statistic. Can return additional stats.

impl TakeFn<FSSTArray> for FSSTEncoding

fn take( &self, array: &FSSTArray, indices: &ArrayData, ) -> VortexResult<ArrayData>

Create a new array by taking the values from the array at the given indices.

unsafe fn take_unchecked( &self, array: &Array, indices: &ArrayData, ) -> Result<ArrayData, VortexError>

Create a new array by taking the values from the array at the given indices.

impl<'a> TryFrom<&'a ArrayData> for &'a FSSTArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: &'a ArrayData) -> VortexResult<Self>

Performs the conversion.

impl TryFrom<ArrayData> for FSSTArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: ArrayData) -> VortexResult<Self>

Performs the conversion.

impl ValidityVTable<FSSTArray> for FSSTEncoding

fn is_valid(&self, array: &FSSTArray, index: usize) -> bool

fn logical_validity(&self, array: &FSSTArray) -> LogicalValidity

impl VariantsVTable<FSSTArray> for FSSTEncoding

fn as_utf8_array<'a>( &self, array: &'a FSSTArray, ) -> Option<&'a dyn Utf8ArrayTrait>

fn as_binary_array<'a>( &self, array: &'a FSSTArray, ) -> Option<&'a dyn BinaryArrayTrait>

fn as_null_array<'a>(&self, _array: &'a Array) -> Option<&'a dyn NullArrayTrait>

fn as_bool_array<'a>(&self, _array: &'a Array) -> Option<&'a dyn BoolArrayTrait>

fn as_primitive_array<'a>( &self, _array: &'a Array, ) -> Option<&'a dyn PrimitiveArrayTrait>

fn as_struct_array<'a>( &self, _array: &'a Array, ) -> Option<&'a dyn StructArrayTrait>

fn as_list_array<'a>(&self, _array: &'a Array) -> Option<&'a dyn ListArrayTrait>

fn as_extension_array<'a>( &self, _array: &'a Array, ) -> Option<&'a dyn ExtensionArrayTrait>

impl VisitorVTable<FSSTArray> for FSSTEncoding

fn accept( &self, array: &FSSTArray, visitor: &mut dyn ArrayVisitor, ) -> VortexResult<()>

impl ArrayTrait for FSSTArray

impl BinaryArrayTrait for FSSTArray

impl Utf8ArrayTrait for FSSTArray