Struct ProbeState 

pub struct ProbeState<'a, V: VTable> { /* private fields */ }

Everything an encoding’s probe_scalar runs with: the typed view of the array being read and, for a repeated read, a borrow of the state its RepeatedArrayProbe keeps.

Passed to OperationsVTable::probe_scalar. A one-off read gets ProbeState::once, which holds only the view. A repeated read borrows the encoding’s own state and the lazily created child probes. Neither owns anything, so building one per read is free.

Encodings never inspect the policy: ProbeState::slot hands out a probe over a child under whichever policy is in force, ProbeState::retained hands out the encoding state only when it is kept, and ProbeState::split gives both at once.

Implementations

impl<'a, V: VTable> ProbeState<'a, V>

pub fn once(array: ArrayView<'a, V>) -> Self

State for a single read of array.

Encodings use it to run their probe_scalar path from the deprecated scalar_at; it goes away with scalar_at.

pub fn array(&self) -> ArrayView<'a, V>

The typed view of the array being read.

pub fn is_valid( &mut self, index: usize, ctx: &mut ExecutionCtx, ) -> VortexResult<bool>

Whether the row at index of the array being read is valid. Will use the cached state to resolve the query.

pub fn retained(&mut self) -> Option<&mut EncodingProbeState<V>>

The encoding’s retained state, or None for a one-off read.

Encodings whose repeated algorithm differs from their one-off one branch on this. To hold the state while reading children, use Self::split.

pub fn split( &mut self, ) -> (Option<&mut EncodingProbeState<V>>, ProbeChildren<'_, 'a, V>)

The encoding’s retained state and the array’s children, borrowed apart, so a cache can stay borrowed while children are read.

pub fn slot(&mut self, slot: usize) -> VortexResult<Option<ArrayProbe<'_>>>

A probe over the array’s child in slot, under this state’s policy.

Shorthand for Self::split followed by ProbeChildren::slot. None if the slot is absent, an error if it is out of bounds.