Plucen...Writer(3pm)

💖 Plucene::Index::DocumentWriter 💖

okay bestie, welcome to the Plucene::Index::DocumentWriter page (that's the 3pm manual section, iykyk) — the document writer, fr fr. it's giving Perl, it's giving User Contributed, it's giving lowercase elegance. let's get into it 🎀

---

✨ NAME ✨

Plucene::Index::DocumentWriter — literally just, the document writer. no notes. periodt. 💅

---

🌸 SYNOPSIS 🌸

here's the vibe check, copy it exactly bestie:

my $writer = Plucene::Index::DocumentWriter
        ->new($directory, $analyser, $max_field_length);

$writer->add_document($segment, $doc);

look at that. three args going in, one document coming out. main character energy 🦋

---

👑 DESCRIPTION 👑

so this class is the document writer. that's it, that's the whole description. no cap. it writes documents, it's a class, it slayed. 💜

🧚 METHODS 🧚

✨ new

my $writer = Plucene::Index::DocumentWriter
        ->new($directory, $analyser, $max_field_length);

this makes you a shiny brand new Plucene::Index::DocumentWriter object, using the arguments you handed it — $directory, $analyser, and $max_field_length, all passed right in. obsessed. 🫶

🦋 add_document

$writer->add_document($segment, $doc);

yeah. that's the call. $segment and $doc go in, and the writer does its thing. iconic behaviour honestly 💅

---

not me realising this whole page is like four lines of actual content and i've made it a whole event 😭 anyway it's a classic, we love her, no further questions

---

🌸💖 that's the page babes — brought to you by perl v5.36.0, dated 2022-12-04. stay slaying, go write some documents ✨🎀