Struct elipdotter::query::Query

pub struct Query { /* private fields */ }

A query.

This is just a root Part.

Use parse to create one. You can also use the std::str::FromStr implementation.

Implementations

impl Query

pub fn root(&self) -> &Part

Get a reference to the root node of the query.

pub fn documents<'a, 'b, P: Provider<'a>>( &'b self, provider: &'a P ) -> Documents<'a, 'b, P>

pub fn occurrences<'a>( &'a self, provider: &'a impl OccurenceProvider<'a>, distance_threshold: usize ) -> Result<impl Iterator<Item = Hit> + 'a, IterError>

The distance_threshold is the bytes between two occurrences to consider the “same”, which increases Hit::rating.

Errors

See Self::documents.

Panics

Some implementations of index::OccurenceProvider panic under certain circumstances.

index::SimpleOccurences, for example, panics if you haven’t supplied all the necessary documents.

Trait Implementations

impl Clone for Query

fn clone(&self) -> Query

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Query

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromStr for Query

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq<Query> for Query

fn eq(&self, other: &Query) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Query

impl StructuralEq for Query

impl StructuralPartialEq for Query