Struct tantivy_sstable :: Streamer Copy item path

impl<'a, TSSTable> Streamer<'a, TSSTable, AlwaysMatch>
where TSSTable: SSTable,

pub fn empty() -> Self

impl<'a, TSSTable, A> Streamer<'a, TSSTable, A>
where A: Automaton, A::State: Clone, TSSTable: SSTable,

pub fn advance(&mut self) -> bool

Advance position the stream on the next item. Before the first call to .advance(), the stream is an uninitialized state.

pub fn term_ord(&self) -> TermOrdinal

Returns the TermOrdinal of the given term.

May panic if the called as .advance() as never been called before.

pub fn key(&self) -> &[u8] ⓘ

Accesses the current key.

.key() should return the key that was returned by the .next() method.

If the end of the stream as been reached, and .next() has been called and returned None, .key() remains the value of the last key encountered.

Before any call to .next(), .key() returns an empty array.

pub fn value(&self) -> &TSSTable::Value

Accesses the current value.

Calling .value() after the end of the stream will return the last .value() encountered.

§Panics

Calling .value() before the first call to .advance() returns V::default().

pub fn next(&mut self) -> Option<(&[u8], &TSSTable::Value)>

Return the next (key, value) pair.

Auto Trait Implementations§

impl<'a, TSSTable, A> Freeze for Streamer<'a, TSSTable, A>
where <A as Automaton>::State: Sized, A: Freeze, <TSSTable as SSTable>::ValueReader: Freeze,

impl<'a, TSSTable, A = AlwaysMatch> !RefUnwindSafe for Streamer<'a, TSSTable, A>

impl<'a, TSSTable, A> Send for Streamer<'a, TSSTable, A>
where <A as Automaton>::State: Sized + Send, A: Send, <TSSTable as SSTable>::ValueReader: Send,

impl<'a, TSSTable, A> Sync for Streamer<'a, TSSTable, A>
where <A as Automaton>::State: Sized + Sync, A: Sync, <TSSTable as SSTable>::ValueReader: Sync,

impl<'a, TSSTable, A> Unpin for Streamer<'a, TSSTable, A>
where <A as Automaton>::State: Sized + Unpin, A: Unpin, <TSSTable as SSTable>::ValueReader: Unpin,

impl<'a, TSSTable, A = AlwaysMatch> !UnwindSafe for Streamer<'a, TSSTable, A>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.