Struct vortex_fsst :: FSSTArray Copy item path

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. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

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. Read more

impl FilterFn<FSSTArray> for FSSTEncoding

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

Filter an array by the provided predicate.

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. Read more

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. Read more

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

Auto Trait Implementations§

impl !Freeze for FSSTArray

impl !RefUnwindSafe for FSSTArray

impl Send for FSSTArray

impl Sync for FSSTArray

impl Unpin for FSSTArray

impl !UnwindSafe for FSSTArray

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> ArrayDType for T
where T: AsRef<ArrayData>,

fn dtype(&self) -> &DType

impl<T> ArrayEncodingRef for T
where T: AsRef<ArrayData>,

fn encoding(&self) -> &'static dyn EncodingVTable

impl<T> ArrayLen for T
where T: AsRef<ArrayData>,

fn len(&self) -> usize

fn is_empty(&self) -> bool

impl<A> ArrayNBytes for A
where A: AsRef<ArrayData>,

fn nbytes(&self) -> usize

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

impl<T> ArrayStatistics for T
where T: AsRef<ArrayData>,

fn statistics(&self) -> &dyn Statistics

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

impl<A> ArrayValidity for A
where A: AsRef<ArrayData>,

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

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

fn logical_validity(&self) -> LogicalValidity

Return the logical validity of the array.

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoArrayVariant for T
where T: IntoCanonical,

fn into_null(self) -> Result<NullArray, VortexError>

fn into_bool(self) -> Result<BoolArray, VortexError>

fn into_primitive(self) -> Result<PrimitiveArray, VortexError>

fn into_struct(self) -> Result<StructArray, VortexError>

fn into_list(self) -> Result<ListArray, VortexError>

fn into_varbinview(self) -> Result<VarBinViewArray, VortexError>

fn into_extension(self) -> Result<ExtensionArray, VortexError>

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<A> ToArrayData for A
where A: AsRef<ArrayData>,

fn to_array(&self) -> ArrayData

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

impl<T> ErasedDestructor for T
where T: 'static,

impl<T> MaybeSendSync for T