Plucen...Reader(3pm)

✨ NAME ✨

okay so bestie, this is Plucene::Index::FieldsReader — the icon whose whole job is reading Fields in a Document. yes literally that's it. she reads. she serves. 💅

---

🎀 SYNOPSIS 🎀

my $reader = Plucene::Index::FieldsReader->new(
        $dir_name, $segment, $field_infos);

my Plucene::Document $doc = $reader->doc($offset);

my $size = $reader->size;

like... three lines and you're already living your best indexed life 🌸

---

🦋 DESCRIPTION 🦋

this class gives you access to documents within the index. that's the whole vibe. she's the lil key that opens the door to your docs, no cap 🔑

---

💖 METHODS 💖

🌟 new

my $reader = Plucene::Index::FieldsReader->new(
        $dir_name, $segment, $field_infos);

this will create a new Plucene::Index::FieldsReader with the passed in directory name, segment and field infos. three lil gifts, one gorgeous new reader ✨

---

🌟 size

my $size = $reader->size;

this returns the size. short, sweet, iconic 👑

---

🌟 doc

my Plucene::Document $doc = $reader->doc($offset);

this will return the Plucene::Document object found at the passed in position. you give her an offset, she gives you the whole document. main character behavior fr fr 🫶

---

not me ending the page with the cutest sign-off ever: this page ships with perl v5.36.0, dated 2022-12-04, and it lives under User Contributed Perl Documentation. it's giving vintage but make it slay 💜