[][src]Struct tantivy_fst::raw::StreamBuilder

pub struct StreamBuilder<'f, A = AlwaysMatch> { /* fields omitted */ }

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 'f lifetime parameter refers to the lifetime of the underlying fst.

Methods

impl<'f, A: Automaton> StreamBuilder<'f, A>[src]

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

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

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

Specify a greater-than bound.

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

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

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

Specify a less-than bound.

pub fn backward(self) -> Self[src]

Sets the StreamBuilder to stream the (key, value) backward.

pub fn with_state(self) -> StreamWithStateBuilder<'f, A>[src]

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

Trait Implementations

impl<'a, 'f, A: Automaton> IntoStreamer<'a> for StreamBuilder<'f, A>[src]

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

The type of the item emitted by the stream.

type Into = Stream<'f, A>

The type of the stream to be constructed.

Auto Trait Implementations

impl<'f, A> RefUnwindSafe for StreamBuilder<'f, A> where
    A: RefUnwindSafe

impl<'f, A> Send for StreamBuilder<'f, A> where
    A: Send

impl<'f, A> Sync for StreamBuilder<'f, A> where
    A: Sync

impl<'f, A> Unpin for StreamBuilder<'f, A> where
    A: Unpin

impl<'f, A> UnwindSafe for StreamBuilder<'f, A> where
    A: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.