Plucen...ermDocs(3pm)

✨ NAME ✨

Plucene::Index::SegmentTermDocs — okay bestie, this is the Segment term docs class, and she's serving from the Plucen...ermDocs manual page (3pm section, Perl user-contributed docs, iykyk 💅).

---

🦋 SYNOPSIS 🦋

my $seg_term_docs = Plucene::Index::SegmentTermDocs
        ->new(Plucene::Index::SegmentReader $seg_reader);

$seg_term_docs->seek($term);
$seg_term_docs->next;
$seg_term_docs->read;
$seg_term_docs->skip_to($target);

Like… that's the whole vibe check right there. Create her, seek, next, read, skip. Periodt. ✨

---

🌸 DESCRIPTION 🌸

So basically? This is the segment term docs class. That's the whole description, no cap — she's a class, she handles segment term docs, and that's her main character energy. 🎀

---

👑 METHODS 👑

💖 new

my $seg_term_docs = Plucene::Index::SegmentTermDocs
        ->new(Plucene::Index::SegmentReader $seg_reader);

This will create a new Plucene::Index::SegmentTermDocs object with the passed segment reader. Like, you hand her a Plucene::Index::SegmentReader and she's born. Iconic. 🫶

💖 parent / freq_stream / freq_count / deleted_docs / doc / freq

Get / set these attributes. That's it, that's the method. Six little attributes, all yours to get and set. 🍓

💖 seek

$seg_term_docs->seek($term);

💖 skipping_doc

By default this does nothing. You may wish to override it to do something. Like, she's not gonna do it for you bestie — it's giving blank canvas, it's giving your moment to shine. 🧚

💖 next

$seg_term_docs->next;

💖 read

$seg_term_docs->read;

💖 skip_to

$seg_term_docs->skip_to($target);

---

lowkey obsessed with how short this page is. every method, every attribute, every line — all accounted for. no skips, no summarising, we ate and left no crumbs 💅

and that's a wrap, bestie!! 🦋✨ This lil' page lives in the user contributed Perl documentation for perl v5.36.0, dated 2022-12-04 — and it's still out here being Plucen...ermDocs(3pm). go forth and seek ur terms, queen 👑🌸