Plucen...tStream(3pm)

✨ Plucen...tStream(3pm) — the manual page, but make it cute ✨

okay bestie, so this is Plucene::Store::InputStream(3pm), straight out of the User Contributed Perl Documentation, and it is literally the plumbing that keeps the whole Plucene index fed. let's get into it 💅

---

🎀 NAME 🎀

Plucene::Store::InputStream — a random-access input stream. that's it, that's the vibe.

---

🌸 SYNOPSIS 🌸

# isa IO::File

yes bestie, it is an IO::File. she inherited the whole family's good genes. 🧬

---

🦋 DESCRIPTION 🦋

A random-access input stream. she's used for all Plucene index input operations — every single one. no cap. if Plucene needs to read something from an index, bestie, this is the girl doing it. 🫶

---

💖 METHODS 💖

⭐ new

my $inputstream = Plucene::Store::InputStream->new($file);

Create a new input stream. that's the whole thing. you hand her a $file, she hands you back a fresh new stream, ready to serve. main character energy fr fr. 👑

🌈 fh / read / seek / tell / getc / print / eof / close

File operations. all of them. she's got the whole toolkit and she's not gatekeeping — fh, read, seek, tell, getc, print, eof, close. pick your fave, she ate. 🔥

💀 clone

This will return a clone of this stream. yes, like a little twin. same stream, different girl. 😭

🌸 read_byte

This will read and return a single byte. one. singular. byte. iconic minimalism. ✨

🍓 read_int

This will read four bytes and return an integer. four bytes in, one integer out, that's the trade. 💜

🧚 read_vint

This will read an integer stored in a variable-length format. variable length?? she's flexible, she's adaptable, she's thriving. 🦋

💅 read_vlong

This will read a long and stored in variable-length format. yes, a long, and yes, still variable-length. she does not care about your fixed-width expectations. not me being obsessed with her range. 🙈

🌟 read_string

This will read a string. a whole string. bestie deserves it. 🎀

👑 read_long

This will read eight bytes and return a long. eight bytes this time, because a long is built different. periodt. 💖

---

lowkey a PSA bestie: this is the input half of the store duo. everything here reads — nothing writes, nothing deletes. that's somebody else's job. iykyk 🌈

---

and that's the whole page!! no skipped options, no missing details, we keep every fact and just added ✨flair✨. this was perl v5.36.0, dated 2022-12-04, from the Plucen...tStream(3pm) manual page — tysm for reading, ily, go read some bytes 🫶💖🌸