Xapian:...terator(3)

🌸 NAME 🌸

Search::Xapian::TermIterator — Iterate over sets of terms.

Okay bestie, this is the Xapian:...terator(3) page from the User Contributed Perl Documentation, and it’s literally all about iterating over sets of terms. Periodt. 💅

---

✨ DESCRIPTION ✨

So this object represents a stream of terms. It overloads ++ for advancing the iterator, or you can explicitly call the inc method. This class also overloads eq, ne, ==, !=, and "" (stringification). The operator overloading ate, honestly. 🔥

---

🛠️ METHODS 🛠️

• new — Constructor. Defaults to a uninitialized iterator.
• clone — It’s listed as a method; this page doesn’t give extra deets beyond that. 🫶
• inc — Advance the iterator by one. (Called implictly by ++ overloading.)
• skip_to tname — Skip the iterator to term tname, or the first term after tname if tname isn’t in the list of terms being iterated.
• get_termname — Get the name of the current term.
• get_wdf — Return the wdf of the current term (if meaningful).
• get_termfreq — Return the term frequency of the current term (if meaningful).
• positionlist_begin — Return Search::Xapian::PositionIterator pointing to start of positionlist for current term.
• positionlist_end — Return Search::Xapian::PositionIterator pointing to end of positionlist for current term.
• get_description — Returns a string describing this object.
• equal termiterator — Checks if a termiterator is the same as this termiterator. Also overloaded as the eq and == operators.
• nequal termiterator — Checks if a termiterator is different from this termiterator. Also overloaded as the ne and != operators.

---

👀 SEE ALSO 👀

• Search::Xapian
• Search::Xapian::Document

Go give them a lil read, bestie. These are the connected vibes. 🦋

---

Mwah 💋 — this iconic page is from perl v5.42.0, dated 2022-02-28, and it’s the Xapian:...terator(3) manual page. Byeee 🎀✨