Struct tantivy :: termdict :: TermStreamer Copy item path

impl<'a, A> TermStreamer<'a, A>
where A: Automaton,

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) -> &TermInfo

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], &TermInfo)>

Return the next (key, value) pair.

Auto Trait Implementations§

impl<'a, A> Freeze for TermStreamer<'a, A>
where A: Freeze,

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

impl<'a, A> Send for TermStreamer<'a, A>
where A: Send, <A as Automaton>::State: Send,

impl<'a, A> Sync for TermStreamer<'a, A>
where A: Sync, <A as Automaton>::State: Sync,

impl<'a, A> Unpin for TermStreamer<'a, A>
where A: Unpin, <A as Automaton>::State: Unpin,

impl<'a, A = AlwaysMatch> !UnwindSafe for TermStreamer<'a, 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> Downcast for T
where T: Any,

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

impl<T> DowncastSync for T
where T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.