Struct tantivy::termdict::TermStreamer

source · [−]

pub struct TermStreamer<'a, A = AlwaysMatch> where
    A: Automaton,  { /* private fields */ }

Expand description

TermStreamer acts as a cursor over a range of terms of a segment. Terms are guaranteed to be sorted.

Implementations

source

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

source

pub fn advance(&mut self) -> bool

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

source

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.

source

pub fn key(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [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.

source

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().

source

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

Return the next (key, value) pair.

Auto Trait Implementations

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

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> Downcast for T where
T: Any,

source

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

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. Read more

source

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

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

source

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. Read more

source

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. Read more

source

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

source

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

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

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

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> Pointable for T

const ALIGN: usize = mem::align_of::()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

Struct tantivy::termdict::TermStreamer

Implementations

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

pub fn advance(&mut self) -> bool

pub fn term_ord(&self) -> TermOrdinal

pub fn key(&self) -> &[u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

pub fn value(&self) -> &TermInfo

Panics

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

Auto Trait Implementations

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

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

fn borrow(&self) -> &T

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

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

impl<T> Downcast for T where T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

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

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

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

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

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

type Error = Infallible

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

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

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

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> Fruit for T where T: Send + Downcast,

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

pub fn key(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

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

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<T> Any for T where
T: 'static + ?Sized,

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

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

impl<T> Downcast for T where
T: Any,

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

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

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

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

impl<T> Fruit for T where
T: Send + Downcast,