pub struct TermQuery { /* private fields */ }
Expand description
A Term query matches all of the documents containing a specific term.
The score associated is defined as
idf
* sqrt(term_freq
/ field norm
)
in which :
idf
- inverse document frequency.term_freq
- number of occurrences of the term in the fieldfield norm
- number of tokens in the field.
use tantivy::collector::{Count, TopDocs};
use tantivy::query::TermQuery;
use tantivy::schema::{Schema, TEXT, IndexRecordOption};
use tantivy::{doc, Index, IndexWriter, Term};
let mut schema_builder = Schema::builder();
let title = schema_builder.add_text_field("title", TEXT);
let schema = schema_builder.build();
let index = Index::create_in_ram(schema);
{
let mut index_writer: IndexWriter = index.writer(15_000_000)?;
index_writer.add_document(doc!(
title => "The Name of the Wind",
))?;
index_writer.add_document(doc!(
title => "The Diary of Muadib",
))?;
index_writer.add_document(doc!(
title => "A Dairy Cow",
))?;
index_writer.add_document(doc!(
title => "The Diary of a Young Girl",
))?;
index_writer.commit()?;
}
let reader = index.reader()?;
let searcher = reader.searcher();
let query = TermQuery::new(
Term::from_field_text(title, "diary"),
IndexRecordOption::Basic,
);
let (top_docs, count) = searcher.search(&query, &(TopDocs::with_limit(2), Count))?;
assert_eq!(count, 2);
Ok(())
Implementations§
source§impl TermQuery
impl TermQuery
sourcepub fn new(term: Term, segment_postings_options: IndexRecordOption) -> TermQuery
pub fn new(term: Term, segment_postings_options: IndexRecordOption) -> TermQuery
Creates a new term query.
sourcepub fn specialized_weight(
&self,
enable_scoring: EnableScoring<'_>
) -> Result<TermWeight>
pub fn specialized_weight( &self, enable_scoring: EnableScoring<'_> ) -> Result<TermWeight>
Returns a weight object.
While .weight(...)
returns a boxed trait object,
this method return a specific implementation.
This is useful for optimization purpose.
Trait Implementations§
source§impl Query for TermQuery
impl Query for TermQuery
source§fn weight(&self, enable_scoring: EnableScoring<'_>) -> Result<Box<dyn Weight>>
fn weight(&self, enable_scoring: EnableScoring<'_>) -> Result<Box<dyn Weight>>
Create the weight associated with a query. Read more
source§fn query_terms<'a>(&'a self, visitor: &mut dyn FnMut(&'a Term, bool))
fn query_terms<'a>(&'a self, visitor: &mut dyn FnMut(&'a Term, bool))
Extract all of the terms associated with the query and pass them to the
given closure. Read more
source§fn explain(
&self,
searcher: &Searcher,
doc_address: DocAddress
) -> Result<Explanation>
fn explain( &self, searcher: &Searcher, doc_address: DocAddress ) -> Result<Explanation>
Returns an
Explanation
for the score of the document.Auto Trait Implementations§
impl Freeze for TermQuery
impl RefUnwindSafe for TermQuery
impl Send for TermQuery
impl Sync for TermQuery
impl Unpin for TermQuery
impl UnwindSafe for TermQuery
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn 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
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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
.source§fn as_any(&self) -> &(dyn Any + 'static)
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.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
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.