Struct StreamingQueryEngine 

pub struct StreamingQueryEngine<'a, const K: usize>
where
    Kmer<K>: KmerBits,
{ /* private fields */ }

Streaming query engine integrated with Dictionary

This provides the full streaming query functionality by connecting to a Dictionary instance for actual k-mer lookups.

Implementations

impl<'a, const K: usize> StreamingQueryEngine<'a, K>

where Kmer<K>: KmerBits,

pub fn new(dict: &'a Dictionary) -> Self

Create a new streaming query engine for a dictionary

pub fn reset(&mut self)

Reset the query state

pub fn lookup(&mut self, kmer_bytes: &[u8]) -> LookupResult

Perform a streaming lookup

pub fn num_searches(&self) -> u64

Get the number of full searches performed

pub fn num_extensions(&self) -> u64

Get the number of extensions (no search needed)

pub fn stats(&self) -> StreamingQueryStats

Get statistics

Trait Implementations

impl<'a, const K: usize> KmerStreamingQuery for StreamingQueryEngine<'a, K>

where Kmer<K>: KmerBits,

const PREFERS_BITS: bool = false

Hint to hot-loop callers: does this engine benefit from receiving pre-computed canonical k-mer bits? Byte-oriented engines (e.g. sshash) set this to false so callers skip the canonicalization/bit conversion work; bit-oriented engines (e.g. tiny-dict) set it to true.

fn reset(&mut self)

Drop any streaming state so the next lookup parses its k-mer from scratch.

fn lookup(&mut self, kmer_bytes: &[u8]) -> LookupResult

Look up a single k-mer (ASCII bytes, length = k).

fn lookup_bits( &mut self, _canonical_bits: u64, _fw_is_canonical: bool, fw_bytes: &[u8], ) -> LookupResult

Look up by pre-parsed canonical k-mer bits plus the original FW bytes.

fn num_searches(&self) -> u64

Number of lookups that required a full dictionary search (slow path).

fn num_extensions(&self) -> u64

Number of lookups resolved by extending along the current unitig (fast path).

fn skip_anchor_along_string(&mut self, _read_offset: i32) -> bool

Offset the current anchor along its SPSS string by read_offset read-positions, without performing a full lookup. Returns true when the anchor was successfully shifted (the caller must have independently verified the sequence agreement, e.g. via a direct SPSS compare), and subsequent consecutive lookups may use the fast path. Returns false if the engine has no anchor concept, no current anchor, or the shifted position would leave the string.