Plucen...archer(3pm)

💖 Plucene::Search::IndexSearcher 💖

okay bestie, gather round 🫶 this is a page from the User Contributed Perl Documentation — it's the 3pm manual for Plucene::Search::IndexSearcher, which is giving very main character energy in the Plucene search lineup. iykyk. ✨

---

✨ NAME ✨

Plucene::Search::IndexSearcher — literally the index searcher. that's her. that's the whole vibe. 👑

---

🎀 SYNOPSIS 🎀

here's the tea, copied exactly so you can steal it:

# isa Plucene::Search::Searcher

my $searcher = Plucene::Search::IndexSearcher
        ->new(Plucene::Index::Reader $reader);

my Plucene::Index::Reader $reader = $searcher->reader;
my         Plucene::Document $doc = $reader->doc($id);

$searcher->close;

no cap, she inherits from Plucene::Search::Searcher, so everything in that family tree is hers too 💅

---

🌸 DESCRIPTION 🌸

Search over an IndexReader. that's it. that's the job. she searches. she slays. 🌈

---

💅 METHODS 💅

💜 new

my $searcher = Plucene::Search::IndexSearcher
        ->new(Plucene::Index::Reader $reader);

this will create a new Searcher object with the passed Plucene::Index::Reader or any subclass thereof. so you can bring your own reader flavor, she's not picky, she's just ✨ particular ✨

💜 reader

my Plucene::Index::Reader $reader = $searcher->reader;

this will return the reader this searcher was made with. it's giving "who raised you" energy, but affectionate 🥹 — she just tells you which reader she's been rolling with this whole time.

💜 search_top

The top search results. that's the whole description, bestie. she's mysterious like that. 🦋

💜 doc

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

this will return the Plucene::Document $id. hand her an id, she hands you the doc. iconic exchange. 📄✨

💜 doc_freq / max_doc

get / set these — yep, they're accessors, that's the entire note. read 'em, write 'em, live your truth 💅

💜 close

this will close the reader(s) associated with the searcher. plural, bestie — reader(s) 👀 — so say your goodbyes properly before you dip 🫶

---

real talk: this page is short and that is not a me problem, that's a her problem. every single option, method and line above is the whole thing, fr fr. don't go inventing extra behaviour that isn't written down here. 🙈

---

and that's the page, babe 💖 this whole manual came to you from perl v5.36.0, dated 2022-12-04, and yes it really does say Plucen...archer(3pm) up in the header because the name got cut off — we still knew who she was though. periodt. 🌈👑🎀