PDF::AP...::Filter(3)

✨ PDF::API2::Basic::PDF::Filter 💖

okay bestie, welcome to PDF::AP...::Filter(3) — yes the manual name is literally truncated like that, that's just how the header rolls, don't @ me 🎀

---

🌸 NAME 🌸

PDF::API2::Basic::PDF::Filter — the abstract superclass for PDF stream filters. it's giving blueprint energy: it doesn't do the work itself, it just defines the whole vibe that every actual filter inherits 💅

---

🦋 SYNOPSIS 🦋

$f = PDF::API2::Basic::PDF::Filter->new;
$str = $f->outfilt($str, 1);
print OUTFILE $str;

while (read(INFILE, $dat, 4096))
{ $store .= $f->infilt($dat, 0); }
$store .= $f->infilt("", 1);

like… this is the whole flow. make a filter, push data through it, pull data back out. iconic behavior fr fr 🔥

---

💜 DESCRIPTION 💜

so a Filter object is literally just a lil container of state information for the process of outputting and inputting data through the filter. that's it. that's the job. ✨

the precise state information stored? honestly up to the particular filter. could range from nothing at all to whole objects created and destroyed. no cap, it's that open-ended. 🙈

and here's the slay part: each filter stores different state information for input and output, so it can handle one input filtering process and one output filtering process at the same time. multitasking queen 👑

---

🧚 METHODS 🧚

⭐ PDF::API2::Basic::PDF::Filter->new

creates a brand new filter object with empty state information, all fresh and ready to process data in both directions — input and output. main character debut moment 💖

---

⭐ $dat = $f->infilt($str, $isend)

filters the data from output to input. yes that's the direction, that's just how it is bestie 🦋

notice this: $isend == 0 implies there's more data to come, so following it, $f may contain state information — usually because the break-off point of $str wasn't tidy 😭. subsequent calls will incorporate that stored state information. so like, it remembers where it was. memory queen 🧠✨

$isend == 1 implies there is no more data to follow. the final state of $f will be that the state information is empty. and ngl, error messages are most likely to occur here — because if there's required state information to be stored following this data, then that would imply an error in the data. 💀

lowkey the $isend == 1 call is the vibe check of the whole filter. if there's leftover state, something went wrong. periodt.

---

⭐ $str = $f->outfilt($dat, $isend)

filters stored data ready for output. it parallels "infilt" — same energy, opposite direction 🎀

---

and that's the whole page bestie!! now go filter some streams 💅

---

cute lil sign-off: this page is from perl v5.42.0, dated 2025-09-01, and it's part of the User Contributed Perl Documentation for PDF::AP...::Filter(3). mwah 🫶