Skip to main content

StreamingQuery

Struct StreamingQuery 

Source
pub struct StreamingQuery<const K: usize>
where Kmer<K>: KmerBits,
{ /* private fields */ }
Expand description

Streaming query engine for efficient consecutive k-mer lookups

This struct maintains state across multiple lookups to optimize queries for sliding windows over sequences.

§Example

use sshash_lib::streaming_query::StreamingQuery;
// Assuming we have a dictionary...
// let mut query = StreamingQuery::new(&dict, true); // canonical=true
// 
// Process consecutive k-mers efficiently
// let result1 = query.lookup("ACGTACGTACGTACGTACGTACGTACGTACG");
// let result2 = query.lookup("CGTACGTACGTACGTACGTACGTACGTACGT"); // Sliding by 1

Implementations§

Source§

impl<const K: usize> StreamingQuery<K>
where Kmer<K>: KmerBits,

Source

pub fn new(k: usize, m: usize, canonical: bool) -> Self

Create a new streaming query engine

§Arguments
  • k - K-mer size
  • m - Minimizer size
  • canonical - Whether to use canonical k-mers (min of forward/RC)
Source

pub fn reset(&mut self)

Reset the query state (call this when starting a new sequence)

Source

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

Perform a streaming lookup for a k-mer

This is the main entry point for queries. For optimal performance, call this with consecutive k-mers (sliding by 1 base at a time).

§Arguments
  • kmer_str - DNA string of length K
§Returns

A LookupResult indicating whether the k-mer was found and its location

Source

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

Perform a streaming lookup with dictionary integration.

Accepts a &Dictionary at call time rather than storing a reference, so callers can manage the dictionary’s lifetime independently (e.g. via Arc).

Source

pub fn num_searches(&self) -> u64

Get the number of full searches performed

Source

pub fn num_extensions(&self) -> u64

Get the number of extensions (no search needed)

Source

pub fn num_positive_lookups(&self) -> u64

Get the number of positive lookups (found)

Source

pub fn num_negative_lookups(&self) -> u64

Get the number of negative lookups (not found)

Source

pub fn num_invalid_lookups(&self) -> u64

Get the number of invalid lookups (malformed input)

Auto Trait Implementations§

§

impl<const K: usize> !Freeze for StreamingQuery<K>

§

impl<const K: usize> !RefUnwindSafe for StreamingQuery<K>

§

impl<const K: usize> Send for StreamingQuery<K>
where Kmer<K>: Sized,

§

impl<const K: usize> Sync for StreamingQuery<K>
where Kmer<K>: Sized,

§

impl<const K: usize> !Unpin for StreamingQuery<K>

§

impl<const K: usize> !UnsafeUnpin for StreamingQuery<K>

§

impl<const K: usize> !UnwindSafe for StreamingQuery<K>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CastableFrom<T> for T

Source§

fn cast_from(value: T) -> T

Call Self as W
Source§

impl<T, U> CastableInto<U> for T
where U: CastableFrom<T>,

Source§

fn cast(self) -> U

Call W::cast_from(self)
Source§

impl<T> DowncastableFrom<T> for T

Source§

fn downcast_from(value: T) -> T

Truncate the current UnsignedInt to a possibly smaller size
Source§

impl<T, U> DowncastableInto<U> for T
where U: DowncastableFrom<T>,

Source§

fn downcast(self) -> U

Call W::downcast_from(self)
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

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

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

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
Source§

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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Splat<T> for T

Source§

fn splat(value: T) -> T

Source§

impl<T> To<T> for T

Source§

fn to(self) -> T

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> UpcastableFrom<T> for T

Source§

fn upcast_from(value: T) -> T

Extend the current UnsignedInt to a possibly bigger size.
Source§

impl<T, U> UpcastableInto<U> for T
where U: UpcastableFrom<T>,

Source§

fn upcast(self) -> U

Call W::upcast_from(self)
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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