pub struct FSSTArray { /* private fields */ }
Implementations§
Source§impl FSSTArray
impl FSSTArray
Sourcepub fn try_new(
dtype: DType,
symbols: Buffer<Symbol>,
symbol_lengths: Buffer<u8>,
codes: VarBinArray,
uncompressed_lengths: ArrayRef,
) -> VortexResult<Self>
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.
Sourcepub fn symbol_lengths(&self) -> &Buffer<u8>
pub fn symbol_lengths(&self) -> &Buffer<u8>
Access the symbol table array
Sourcepub fn codes(&self) -> &VarBinArray
pub fn codes(&self) -> &VarBinArray
Access the codes array
Sourcepub fn codes_dtype(&self) -> &DType
pub fn codes_dtype(&self) -> &DType
Get the DType of the codes array
Sourcepub fn uncompressed_lengths(&self) -> &ArrayRef
pub fn uncompressed_lengths(&self) -> &ArrayRef
Get the uncompressed length for each element in the array.
Sourcepub fn uncompressed_lengths_dtype(&self) -> &DType
pub fn uncompressed_lengths_dtype(&self) -> &DType
Get the DType of the uncompressed lengths array
Trait Implementations§
Source§impl BatchOperator for FSSTArray
impl BatchOperator for FSSTArray
fn bind(&self, _ctx: &mut dyn BatchBindCtx) -> VortexResult<BatchExecutionRef>
Source§impl Operator for FSSTArray
impl Operator for FSSTArray
Source§fn id(&self) -> OperatorId
fn id(&self) -> OperatorId
The unique identifier for this operator instance.
Source§fn children(&self) -> &[OperatorRef] ⓘ
fn children(&self) -> &[OperatorRef] ⓘ
The children of this operator.
Source§fn with_children(
self: Arc<Self>,
_children: Vec<OperatorRef>,
) -> VortexResult<OperatorRef>
fn with_children( self: Arc<Self>, _children: Vec<OperatorRef>, ) -> VortexResult<OperatorRef>
Create a new instance of this operator with the given children. Read more
Source§fn reduce_parent(
&self,
parent: OperatorRef,
_child_idx: usize,
) -> VortexResult<Option<OperatorRef>>
fn reduce_parent( &self, parent: OperatorRef, _child_idx: usize, ) -> VortexResult<Option<OperatorRef>>
Attempt to push down a parent operator through this node. Read more
Source§fn as_batch(&self) -> Option<&dyn BatchOperator>
fn as_batch(&self) -> Option<&dyn BatchOperator>
Returns this operator as a
BatchOperator
if it supports batch execution.Source§fn fmt_as(&self, _df: DisplayFormat, f: &mut Formatter<'_>) -> Result<(), Error>
fn fmt_as(&self, _df: DisplayFormat, f: &mut Formatter<'_>) -> Result<(), Error>
Override the default formatting of this operator.
Source§fn reduce_children(&self) -> Result<Option<Arc<dyn Operator>>, VortexError>
fn reduce_children(&self) -> Result<Option<Arc<dyn Operator>>, VortexError>
Attempt to optimize this node by analyzing its children. Read more
Source§fn is_selection_target(&self, _child_idx: usize) -> Option<bool>
fn is_selection_target(&self, _child_idx: usize) -> Option<bool>
Return
true
if the given child is considered to be a selection target. Read moreSource§fn as_pipelined(&self) -> Option<&(dyn PipelinedOperator + 'static)>
fn as_pipelined(&self) -> Option<&(dyn PipelinedOperator + 'static)>
Returns this operator as a
PipelinedOperator
if it supports pipelined execution. Read moreSource§impl OperatorEq for FSSTArray
impl OperatorEq for FSSTArray
fn operator_eq(&self, other: &Self) -> bool
Source§impl OperatorHash for FSSTArray
impl OperatorHash for FSSTArray
fn operator_hash<H: Hasher>(&self, state: &mut H)
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§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> DynOperatorEq for Twhere
T: OperatorEq + 'static,
impl<T> DynOperatorEq for Twhere
T: OperatorEq + 'static,
fn dyn_operator_eq(&self, other: &(dyn Any + 'static)) -> bool
Source§impl<T> DynOperatorHash for Twhere
T: OperatorHash + ?Sized,
impl<T> DynOperatorHash for Twhere
T: OperatorHash + ?Sized,
fn dyn_operator_hash(&self, state: &mut dyn Hasher)
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
Causes
self
to use its Binary
implementation when Debug
-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
Causes
self
to use its Display
implementation when
Debug
-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
Causes
self
to use its LowerExp
implementation when
Debug
-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
Causes
self
to use its LowerHex
implementation when
Debug
-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
Causes
self
to use its Octal
implementation when Debug
-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
Causes
self
to use its Pointer
implementation when
Debug
-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
Causes
self
to use its UpperExp
implementation when
Debug
-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
Causes
self
to use its UpperHex
implementation when
Debug
-formatted.Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
Borrows
self
and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
Mutably borrows
self
and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows
self
, then passes self.as_ref()
into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows
self
, then passes self.as_mut()
into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows
self
, then passes self.deref()
into the pipe function.Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the
Borrow<B>
of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the
BorrowMut<B>
of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the
AsRef<R>
view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the
AsMut<R>
view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the
Deref::Target
of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the
Deref::Target
of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap()
only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls
.tap_borrow()
only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls
.tap_ref()
only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls
.tap_ref_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls
.tap_deref()
only in debug builds, and is erased in release
builds.