Xapian:...Iterator(3)

🌸 NAME 🌸

Search::Xapian::ValueIterator — iterate over value slots in a document. That's the whole assignment, bestie. Slay. 💅

This is the Xapian:...Iterator(3) page from the User Contributed Perl Documentation, and it's giving tiny but iconic Perl object. 🦋

✨ DESCRIPTION ✨

Okay so this object represents a stream of document values. It overloads ++ for advancing the iterator, or you can explicitly call the inc method. No cap. 💖

This class also overloads eq, ne, ==, !=, and "" (stringification). Yes bestie, that "" is the stringification operator — it's in the mix too. 🎀

💅 METHODS 💅

• new — the constructor. Defaults to a uninitialized iterator. 🫶
• clone — it's a method, and the page lists it right here. No extra description on this one, so I'm not gonna make one up. 🙈
• inc — advance the iterator by one. (Called implicitly by ++ overloading.) ⭐
• get_valueno — return the number of the value slot at the current position. 🔢
• get_value — return the string in the value slot at current position. Also overloaded as the "" operator. 🍓
• get_description — returns a string describing this object. 📝
• equal <valueiterator> — checks if a valueiterator is the same as this valueiterator. Also overloaded as the eq and != operators. (yep, that's what the page says — keeping it exactly.) 💀
• nequal <valueiterator> — checks if a valueiterator is different from this valueiterator. Also overloaded as the ne and != operators. 🔥

🌈 SEE ALSO 🌈

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

Those are your besties to go check out next. 👑

---

okay that's the whole page, bestie — sign-off time: this is perl v5.42.0, dated 2022-02-28, and the page is Xapian:...Iterator(3). mwah 💖✨🎀 periodt.