Struct FSSTArray

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

Implementations

impl FSSTArray

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

Optionally downcast an Array 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: Array, symbol_lengths: Array, codes: Array, uncompressed_lengths: Array, ) -> 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) -> Array

Access the symbol table array

pub fn symbol_lengths(&self) -> Array

Access the symbol table array

pub fn codes(&self) -> Array

Access the codes array

pub fn codes_dtype(&self) -> DType

Get the DType of the codes array

pub fn uncompressed_lengths(&self) -> Array

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.

Methods from Deref<Target = Array>

pub fn vtable(&self) -> &VTableRef

Return the array’s encoding VTable.

pub fn encoding(&self) -> EncodingId

Return the array’s encoding ID.

pub fn len(&self) -> usize

Returns the number of logical elements in the array.

pub fn is_empty(&self) -> bool

Check whether the array has any data

pub fn dtype(&self) -> &DType

Return the array’s dtype

pub fn is_canonical(&self) -> bool

Whether the array is of a canonical encoding.

pub fn is_arrow(&self) -> bool

Whether the array is fully zero-copy to Arrow (including children). This means any nested types, like Structs, Lists, and Extensions are not present.

pub fn is_constant(&self) -> bool

Return whether the array is constant.

pub fn as_constant(&self) -> Option<Scalar>

Return scalar value of this array if the array is constant

pub fn child<'a>( &'a self, idx: usize, dtype: &'a DType, len: usize, ) -> Result<Array, VortexError>

pub fn children(&self) -> Vec<Array>

Returns a Vec of Arrays with all the array’s child arrays.

pub fn named_children(&self) -> Vec<(String, Array)>

Returns a Vec of Arrays with all the array’s child arrays.

pub fn nchildren(&self) -> usize

Returns the number of child arrays

pub fn depth_first_traversal(&self) -> ArrayChildrenIterator

pub fn cumulative_nbuffers(&self) -> usize

Count the number of cumulative buffers encoded by self.

pub fn all_buffer_offsets(&self, alignment: usize) -> Vec<u64>

Return the buffer offsets and the total length of all buffers, assuming the given alignment. This includes all child buffers.

pub fn metadata_bytes(&self) -> Option<&[u8]>

pub fn nbuffers(&self) -> usize

pub fn byte_buffer(&self, index: usize) -> Option<&Buffer<u8>>

pub fn byte_buffers(&self) -> impl Iterator<Item = Buffer<u8>>

pub fn is_encoding(&self, id: EncodingId) -> bool

Checks whether array is of a given encoding.

pub fn try_downcast_ref<E>( &self, ) -> Result<(&<E as Encoding>::Array, &E), VortexError>

where E: Encoding, &'a <E as Encoding>::Array: for<'a> TryFrom<&'a Array, Error = VortexError>,

pub fn nbytes(&self) -> usize

Total size of the array in bytes, including all children and buffers.

pub fn statistics(&self) -> &dyn Statistics

pub fn inherit_statistics(&self, parent: &dyn Statistics)

pub fn tree_display(&self) -> TreeDisplayWrapper<'_>

pub fn is_valid(&self, index: usize) -> Result<bool, VortexError>

Return whether the element at the given index is valid (true) or null (false).

pub fn all_valid(&self) -> Result<bool, VortexError>

Return whether all elements in the array are valid.

pub fn null_count(&self) -> Result<usize, VortexError>

Return the number of null elements in the array.

pub fn validity_mask(&self) -> Result<Mask, VortexError>

Return the canonical validity of the array as a Mask.

pub fn as_null_array(&self) -> Option<&dyn NullArrayTrait>

pub fn as_bool_array(&self) -> Option<&dyn BoolArrayTrait>

pub fn as_primitive_array( &self, ) -> Option<&dyn PrimitiveArrayTrait<Target = Array>>

pub fn as_utf8_array(&self) -> Option<&dyn Utf8ArrayTrait>

pub fn as_binary_array(&self) -> Option<&dyn BinaryArrayTrait>

pub fn as_struct_array(&self) -> Option<&dyn StructArrayTrait<Target = Array>>

pub fn as_list_array(&self) -> Option<&dyn ListArrayTrait>

pub fn as_extension_array( &self, ) -> Option<&dyn ExtensionArrayTrait<Target = Array>>

Trait Implementations

impl AsRef<Array> for FSSTArray

fn as_ref(&self) -> &Array

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

impl CanonicalVTable<FSSTArray> for FSSTEncoding

fn into_canonical(&self, array: FSSTArray) -> VortexResult<Canonical>

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: &Array, operator: Operator, ) -> VortexResult<Option<Array>>

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 Deref for FSSTArray

type Target = Array

The resulting type after dereferencing.

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

Dereferences the value.

impl FilterFn<FSSTArray> for FSSTEncoding

fn filter(&self, array: &FSSTArray, mask: &Mask) -> VortexResult<Array>

Filter an array by the provided predicate.

impl IntoArray for FSSTArray

fn into_array(self) -> Array

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<Array>

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: &Array) -> VortexResult<Array>

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

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

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

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

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Array> for FSSTArray

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl ValidateVTable<FSSTArray> for FSSTEncoding

fn validate(&self, _array: &Array) -> Result<(), VortexError>

impl ValidityVTable<FSSTArray> for FSSTEncoding

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

Returns whether the index item is valid.

fn all_valid(&self, array: &FSSTArray) -> VortexResult<bool>

Returns whether the array is all valid.

fn validity_mask(&self, array: &FSSTArray) -> VortexResult<Mask>

fn invalid_count(&self, array: &Array) -> Result<usize, VortexError>

Returns the number of invalid elements in the array.

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<Target = Array>>

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

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<Target = Array>>

impl VisitorVTable<FSSTArray> for FSSTEncoding

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

impl BinaryArrayTrait for FSSTArray

impl Utf8ArrayTrait for FSSTArray