Xapian:...terator(3)

okay bestie, welcome to the Xapian:...terator(3) page — officially filed under User Contributed Perl Documentation — and it's all about Search::Xapian::PositionIterator. It's giving iterator-but-make-it-cute. 💅✨

💖 NAME 💖

Search::Xapian::PositionIterator - Iterate over sets of positions.

✨ DESCRIPTION ✨

This iterator represents a stream of positions for a term. It overloads ++ for advancing the iterator, or you can explicitly call the inc method. This class also overloads eq, ne, ==, !=, "" (stringification) and 0+ (conversion to an integer). No cap, that's the whole vibe. 🦋

🎀 METHODS 🎀

• new — constructor, bestie. Defaults to an uninitialized iterator, so if you don't hand it anything it's just sitting there uninitialized. 🙈
• clone — the clone method is listed here. The original gives no extra description, so I'm not gonna invent lore. periodt. 💀
• inc — advance the iterator by one. It's called implicitly by the ++ overloading, so ++ can do the work or you can call inc yourself. 🔥
• skip_to termpos — skip the iterator to term position termpos, or to the first term position after termpos if termpos isn't in the list of term positions being iterated. 🎯
• equal term — checks if a term is the same as this term. Also overloaded to the eq and == operators. 👑
• nequal term — checks if a term is different from this term. Also overloaded to the ne and != operators. 🌈
• get_termpos — return the term position the iterator is currently on. Also implemented as conversion to an integer. ⭐
• get_description — return a description of this object. Also implemented as stringification. 💜

🌸 SEE ALSO 🌸

Search::Xapian, Search::Xapian::Document — go peek at these too, bestie. They're in the original SEE ALSO and they're staying right here. 🫶

---

mwah 💋 okay bye bestie — this page comes from perl v5.42.0, dated 2022-02-28, and it's the Xapian:...terator(3) manual page. Stay hydrated and may your positions always line up. ✨🎀