Project Lucy has retired. For details please refer to its Attic page.
Lucy::Search::Hits – C API Documentation
Apache Lucy™

Lucy::Search::Hits

parcel Lucy
class variable LUCY_HITS
struct symbol lucy_Hits
class nickname lucy_Hits
header file Lucy/Search/Hits.h

Name

Lucy::Search::Hits – Access search results.

Description

Hits objects are iterators used to access the results of a search.

Methods

Next
lucy_HitDoc* // incremented
lucy_Hits_Next(
    lucy_Hits *self
);

Return the next hit, or NULL when the iterator is exhausted.

Total_Hits
uint32_t
lucy_Hits_Total_Hits(
    lucy_Hits *self
);

Return the total number of documents which matched the Query used to produce the Hits object. Note that this is the total number of matches, not just the number of matches represented by the Hits iterator.

Inheritance

Lucy::Search::Hits is a Clownfish::Obj.