Struct tantivy_sstable::StreamerBuilder

pub struct StreamerBuilder<'a, TSSTable, A = AlwaysMatch>
where
    A: Automaton,
    A::State: Clone,
    TSSTable: SSTable,
{ /* private fields */ }

StreamerBuilder is a helper object used to define a range of terms that should be streamed.

Implementations

impl<'a, TSSTable, A> StreamerBuilder<'a, TSSTable, A>

where A: Automaton, A::State: Clone, TSSTable: SSTable,

pub fn ge<T: AsRef<[u8]>>(self, bound: T) -> Self

Limit the range to terms greater or equal to the bound

pub fn gt<T: AsRef<[u8]>>(self, bound: T) -> Self

Limit the range to terms strictly greater than the bound

pub fn le<T: AsRef<[u8]>>(self, bound: T) -> Self

Limit the range to terms lesser or equal to the bound

pub fn lt<T: AsRef<[u8]>>(self, bound: T) -> Self

Limit the range to terms lesser or equal to the bound

pub fn limit(self, limit: u64) -> Self

Load no more data than what’s required to to get limit matching entries.

The resulting Streamer can still return marginaly more than limit elements.

pub async fn into_stream_async(self) -> Result<Streamer<'a, TSSTable, A>>

See into_stream(..)

pub fn into_stream(self) -> Result<Streamer<'a, TSSTable, A>>

Creates the stream corresponding to the range of terms defined using the StreamerBuilder.