Struct fst::map::StreamWithStateBuilder

pub struct StreamWithStateBuilder<'m, A = AlwaysMatch>(_);

A builder for constructing range queries on streams that include automaton states.

In general, one should use StreamBuilder unless you have a specific need for accessing the states of the underlying automaton that is being used to filter this stream.

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.

Methods

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

pub fn ge<T: AsRef<[u8]>>(self, bound: T) -> StreamWithStateBuilder<'m, A>

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

pub fn gt<T: AsRef<[u8]>>(self, bound: T) -> StreamWithStateBuilder<'m, A>

Specify a greater-than bound.

pub fn le<T: AsRef<[u8]>>(self, bound: T) -> StreamWithStateBuilder<'m, A>

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

pub fn lt<T: AsRef<[u8]>>(self, bound: T) -> StreamWithStateBuilder<'m, A>

Specify a less-than bound.

Trait Implementations

impl<'m, 'a, A: 'a + Automaton> IntoStreamer<'a> for StreamWithStateBuilder<'m, A> where
    A::State: Clone, 

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

The type of the item emitted by the stream.

type Into = StreamWithState<'m, A>

The type of the stream to be constructed.

fn into_stream(self) -> StreamWithState<'m, A>

Construct a stream from Self.