Plucen...ermEnum(3pm)

💖 Plucene::Index::SegmentTermEnum — the segment term enum era 💖

okay bestie, gather round, because we're about to talk about Plucene::Index::SegmentTermEnum, a lil Perl module from the User Contributed Perl Documentation corner of the universe, and honestly? it's giving "small class, big responsibilities." 🎀

This is the segment term enum class, fr fr. That's the whole vibe. It's a class, it's about segment term enums, and it's here to do its job. No notes. 💅

---

✨ SYNOPSIS ✨

here's the whole thing in one glance, no cap:

my $seg_term_enum = Plucene::Index::SegmentTermEnum
        ->new(  Plucene::Store::InputStream $i,
                Plucene::Index::FieldInfos  $fi,
                $is_index);

my $clone = $seg_term_info->clone;

my Plucene::Index::Term $term = $seg_term_enum->read_term;

$seg_term_info->seek($ptr, $position, $term, $term_info);
$seg_term_enum->prev;
$seg_term_enum->next;

look at that. constructor, clone, read_term, seek, prev, next. a whole lil ecosystem. 🌸

---

🌈 DESCRIPTION 🌈

This is the segment term enum class.

that's it. that's the description. short, sweet, main character energy, says exactly what it needs to say and nothing more. i'm obsessed actually. 🦋

---

👑 METHODS 👑

💜 new

my $seg_term_enum = Plucene::Index::SegmentTermEnum
        ->new(  Plucene::Store::InputStream $i,
                Plucene::Index::FieldInfos  $fi,
                $is_index);

this is how you birth a Plucene::Index::SegmentTermEnum, bestie. you hand it a Plucene::Store::InputStream ($i), a Plucene::Index::FieldInfos ($fi), and $is_index. three lil arguments and boom, you got yourself an enum. slay. ✨

---

💖 term / term_info / index_pointer / size / position / doc_freq / freq_pointer / prox_pointer

get / set these attributes.

that's the whole deal — every single one of these is an attribute you can get, and an attribute you can set. term, term_info, index_pointer, size, position, doc_freq, freq_pointer, prox_pointer. collect the whole set, iykyk. 🎀

---

🧚 clone

my $clone = $seg_term_info->clone;

makes a clone. iconic behaviour, honestly. 🫶

---

🔥 seek

$seg_term_info->seek($ptr, $position, $term, $term_info);

seeks with $ptr, $position, $term, and $term_info. four things, one method, we love a clean signature. 💅

---

🌟 prev / next

$seg_term_enum->prev;
$seg_term_enum->next;

prev goes backward. next goes forward. that's the duality of enum, bestie. no cap. 💀

---

🍓 read_term

my Plucene::Index::Term $term = $seg_term_enum->read_term;

reads a term and hands you back a Plucene::Index::Term. literally the payoff of the whole class. periodt. ⭐

---

💌 reminder bestie: this page is the Plucene::Index::SegmentTermEnum page, from the User Contributed Perl Documentation, generated with perl v5.36.0 and dated 2022-12-04. stay hydrated, read your manpages, and go clone something cute. bye bestie! 💖✨🎀🦋🌸