Struct tantivy_fst::map::StreamBuilder

pub struct StreamBuilder<'m, A = AlwaysMatch>(/* private fields */);

A builder for constructing range queries on streams.

Once all bounds are set, one should call into_stream to get a Stream.

Bounds are not additive. That is, if ge is called twice on the same builder, then the second setting wins.

The A type parameter corresponds to an optional automaton to filter the stream. By default, no filtering is done.

The 'm lifetime parameter refers to the lifetime of the underlying map.

Implementations

impl<'m, A: Automaton> StreamBuilder<'m, A>

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

Specify a greater-than-or-equal-to bound.

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

Specify a greater-than bound.

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

Specify a less-than-or-equal-to bound.

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

Specify a less-than bound.

pub fn backward(self) -> Self

Make it iterate backwards.

pub fn with_state(self) -> StreamWithStateBuilder<'m, A>

Return this builder and gives the automaton states along with the results.

Trait Implementations

impl<'m, 'a, A: Automaton> IntoStreamer<'a> for StreamBuilder<'m, A>

type Item = (&'a [u8], u64)

The type of the item emitted by the stream.

type Into = Stream<'m, A>

The type of the stream to be constructed.

fn into_stream(self) -> Self::Into

Construct a stream from Self.