Struct tantivy::query::TermQuery [−][src]
pub struct TermQuery { /* fields omitted */ }
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, 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 = index.writer(3_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
Creates a new term query.
pub fn specialized_weight(
&self,
searcher: &Searcher,
scoring_enabled: bool
) -> Result<TermWeight>
pub fn specialized_weight(
&self,
searcher: &Searcher,
scoring_enabled: bool
) -> 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
Auto Trait Implementations
impl RefUnwindSafe for TermQuery
impl UnwindSafe for TermQuery
Blanket Implementations
Mutably borrows from an owned value. Read more
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
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
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
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