Lucy::...Writer(3pm)

💖 Lucy::Index::SegWriter — a.k.a. "Lucy::...Writer" if ur terminal is being shy 💖

okay bestie, pull up a chair, because this is Lucy::Index::SegWriter, one of the modules from the Lucy Perl distribution (yes, the manpage title gets truncated to Lucy::...Writer(3pm) on some systems, don't worry about it, she's fine 💅), and she is literally the backbone of writing an index. slay.

---

✨ NAME ✨

Lucy::Index::SegWriter — she writes one segment of an index. that's it, that's the job, and she does it flawlessly. periodt.

---

🌸 DESCRIPTION 🌸

okay so picture this: SegWriter is the conduit — the lil pipeline — through which all the info you feed to Indexer passes. everything goes through her. she's giving main character energy fr fr.

she:

• manages Segment and Inverter 👑
• invokes the Analyzer chain ✨
• feeds the low level DataWriters, like PostingListWriter and DocWriter 💅

and the way she knows which sub-components she has? that's all decided by Architecture. iconic.

here's the cute part: any DataWriter components you stack up via add_writer() get Add_Inverted_Doc() invoked for each document you hand to SegWriter's add_doc(). every single one. no skipping. 🫶

---

🎀 METHODS 🎀

🦋 register

$seg_writer->register(
    api       => $api,        # required
    component => $component,  # required
);

register a DataWriter component with the SegWriter. quick heads up tho bestie — registration just makes the writer available via fetch(). that's all it does. so if you also want it actually, y'know, used, you're gonna want to call add_writer() too. don't forget, i'm begging 🙈

• api — the name of the DataWriter api which "writer" implements.
• component — a DataWriter.

---

💜 fetch

my $obj = $seg_writer->fetch($api);

retrieve a registered component. that's the whole vibe.

• api — the name of the DataWriter api which the component implements.

---

⭐ add_writer

$seg_writer->add_writer($writer);

add a DataWriter to the SegWriter's stack of writers. stacking them up like lil legos, we love to see it. 🧱

---

💖 add_doc

$seg_writer->add_doc(
    doc   => $doc,    # required
    boost => $boost,  # default: 1.0
);

add a document to the segment. here's what actually goes down: she inverts doc, increments the Segment's internal document id, and then calls Add_Inverted_Doc(), feeding all the sub-writers. all of them. she's so generous. 😭

• doc — required, bestie, don't skip it.
• boost — default: 1.0.

---

🌈 add_segment

$seg_writer->add_segment(
    reader  => $reader,   # required
    doc_map => $doc_map,  # default: undef
);

add content from an existing segment into the one currently being written. merging eras, we love a collab. 🫶

• reader — the SegReader containing content to add.
• doc_map — an array of integers mapping old document ids to new. deleted documents are mapped to 0, which is the signal that they should be skipped. bye bestie 👋

---

🍓 finish

$seg_writer->finish();

complete the segment: close all streams, store metadata, etc. etc. she's done, she's logged off, she's going to bed. 💤

---

👑 INHERITANCE 👑

Lucy::Index::SegWriter isa Lucy::Index::DataWriter isa Clownfish::Obj.

three generations of iconic behavior, we stan a family tree. 🌳

---

💫 SEE ALSO 💫

(nothing else listed in the original, so this is just me blowing u a lil kiss) 😘

---

and that's the whole page bestie!! 💅✨

this beauty was documented under perl v5.42.0, dated 2025-07-25 — she's a User Contributed Perl Documentation queen, and honestly? timeless. 🎀🦋💖