[][src]Struct tantivy_fst::map::Stream

pub struct Stream<'m, A = AlwaysMatch>(_)
where
    A: Automaton
;

A lexicographically ordered stream of key-value pairs from a map.

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> Stream<'m, A>[src]

pub fn into_byte_vec(self) -> Vec<(Vec<u8>, u64)>[src]

Convert this stream into a vector of byte strings and outputs.

Note that this creates a new allocation for every key in the stream.

pub fn into_str_vec(self) -> Result<Vec<(String, u64)>>[src]

Convert this stream into a vector of Unicode strings and outputs.

If any key is not valid UTF-8, then iteration on the stream is stopped and a UTF-8 decoding error is returned.

Note that this creates a new allocation for every key in the stream.

pub fn into_byte_keys(self) -> Vec<Vec<u8>>[src]

Convert this stream into a vector of byte strings.

Note that this creates a new allocation for every key in the stream.

pub fn into_str_keys(self) -> Result<Vec<String>>[src]

Convert this stream into a vector of Unicode strings.

If any key is not valid UTF-8, then iteration on the stream is stopped and a UTF-8 decoding error is returned.

Note that this creates a new allocation for every key in the stream.

pub fn into_values(self) -> Vec<u64>[src]

Convert this stream into a vector of outputs.

Trait Implementations

impl<'a, 'm, A: Automaton> Streamer<'a> for Stream<'m, A>[src]

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

The type of the item emitted by this stream.

Auto Trait Implementations

impl<'m, A> RefUnwindSafe for Stream<'m, A> where
    A: RefUnwindSafe,
    <A as Automaton>::State: RefUnwindSafe

impl<'m, A> Send for Stream<'m, A> where
    A: Send,
    <A as Automaton>::State: Send

impl<'m, A> Sync for Stream<'m, A> where
    A: Sync,
    <A as Automaton>::State: Sync

impl<'m, A> Unpin for Stream<'m, A> where
    A: Unpin,
    <A as Automaton>::State: Unpin

impl<'m, A> UnwindSafe for Stream<'m, A> where
    A: UnwindSafe,
    <A as Automaton>::State: 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.