xapian-core  2.0.0
Public Member Functions | Private Member Functions | Private Attributes | List of all members
RemoteKeyList Class Reference

Iterate keys in a remote database. More...

#include <remote_keylist.h>

+ Inheritance diagram for RemoteKeyList:
+ Collaboration diagram for RemoteKeyList:

Public Member Functions

 RemoteKeyList (std::string_view prefix, std::string &&data_)
 Construct. More...
 
Xapian::termcount get_approx_size () const
 Return approximate size of this termlist. More...
 
Xapian::doccount get_termfreq () const
 Return the term frequency for the term at the current position. More...
 
TermListnext ()
 Advance the current position to the next term in the termlist. More...
 
TermListskip_to (std::string_view term)
 Skip forward to the specified term. More...
 
- Public Member Functions inherited from AllTermsList
virtual Xapian::termcount get_wdf () const
 Return the wdf for the term at the current position. More...
 
virtual Xapian::termcount positionlist_count () const
 Return true if the current position is past the last term in this list. More...
 
virtual PositionListpositionlist_begin () const
 Return a PositionIterator for the current position. More...
 
- Public Member Functions inherited from Xapian::TermIterator::Internal
virtual ~Internal ()
 We have virtual methods and want to be able to delete derived classes using a pointer to the base class, so we need a virtual destructor. More...
 
virtual void accumulate_stats (Xapian::Internal::ExpandStats &stats) const
 Collate weighting information for the current term. More...
 
const std::string & get_termname () const
 Return the termname at the current position. More...
 
virtual const Xapian::VecCOW< Xapian::termpos > * get_vec_termpos () const
 Get pointer to VecCOW<termpos> if that's the internal representation. More...
 
- Public Member Functions inherited from Xapian::Internal::intrusive_base
 intrusive_base ()
 Construct with no references. More...
 

Private Member Functions

void operator= (const RemoteKeyList &)=delete
 Don't allow assignment. More...
 
 RemoteKeyList (const RemoteKeyList &)=delete
 Don't allow copying. More...
 

Private Attributes

std::string data
 
const char * p = NULL
 

Additional Inherited Members

- Public Attributes inherited from Xapian::TermIterator::Internal
size_t shard_index = 0
 Which shard of a multidatabase this is from. More...
 
- Public Attributes inherited from Xapian::Internal::intrusive_base
unsigned _refs
 Reference count. More...
 
- Protected Member Functions inherited from AllTermsList
 AllTermsList ()
 Only constructable as a base class for derived classes. More...
 
- Protected Member Functions inherited from Xapian::TermIterator::Internal
 Internal ()
 Only constructable as a base class for derived classes. More...
 
- Protected Attributes inherited from Xapian::TermIterator::Internal
std::string current_term
 The current term. More...
 

Detailed Description

Iterate keys in a remote database.

Definition at line 29 of file remote_keylist.h.

Constructor & Destructor Documentation

◆ RemoteKeyList() [1/2]

RemoteKeyList::RemoteKeyList ( const RemoteKeyList )
privatedelete

Don't allow copying.

◆ RemoteKeyList() [2/2]

RemoteKeyList::RemoteKeyList ( std::string_view  prefix,
std::string &&  data_ 
)
inline

Construct.

Definition at line 42 of file remote_keylist.h.

References Xapian::TermIterator::Internal::current_term.

Member Function Documentation

◆ get_approx_size()

Xapian::termcount RemoteKeyList::get_approx_size ( ) const
virtual

Return approximate size of this termlist.

Implements AllTermsList.

Definition at line 31 of file remote_keylist.cc.

◆ get_termfreq()

Xapian::doccount RemoteKeyList::get_termfreq ( ) const
virtual

Return the term frequency for the term at the current position.

Implements AllTermsList.

Definition at line 39 of file remote_keylist.cc.

◆ next()

TermList * RemoteKeyList::next ( )
virtual

Advance the current position to the next term in the termlist.

Implements AllTermsList.

Definition at line 46 of file remote_keylist.cc.

References p, unpack_string_append(), and unpack_throw_serialisation_error().

Referenced by skip_to().

◆ operator=()

void RemoteKeyList::operator= ( const RemoteKeyList )
privatedelete

Don't allow assignment.

◆ skip_to()

TermList * RemoteKeyList::skip_to ( std::string_view  term)
virtual

Skip forward to the specified term.

If the specified term isn't in the list, position ourselves on the first term after term (or at_end() if no terms after term exist).

Implements AllTermsList.

Definition at line 63 of file remote_keylist.cc.

References next(), p, and term.

Member Data Documentation

◆ data

std::string RemoteKeyList::data
private

Definition at line 36 of file remote_keylist.h.

◆ p

const char* RemoteKeyList::p = NULL
private

Definition at line 38 of file remote_keylist.h.


The documentation for this class was generated from the following files: