Struct Documents

pub struct Documents<'a, 'b, P: Provider<'a>> { /* private fields */ }

An iterator of documents which matches a Query.

Implementations

impl<'a, 'b, P: Provider<'a>> Documents<'a, 'b, P>

pub fn iter(&'a self) -> Result<impl Iterator<Item = Id> + 'a, IterError>

Errors

If a Part::Not isn’t associated with a Part::And, IterError::StrayNot is returned.

This is due to a limitation of the index architecture used by this library, and almost all other search engines.

pub fn take_proximate_map(&mut self) -> ProximateMap<'b>

The list of proximate words. This is populated on creation and used in Self::iter. Using Self::ite