POE::Fi...::Stream(3)

✨ NAME ✨

POE::Filter::Zlib::Stream — bestie, it's a POE filter wrapped around Compress::Zlib's deflate and inflate 🎀 (yes the manual has two NAME sections, and honestly? iconic of it. we're keeping both, no cap)

---

💖 VERSION 💖

version 2.04 — she's serving stable release energy 🌸

---

🦋 SYNOPSIS 🦋

use POE::Filter::Zlib::Stream;

my $filter = POE::Filter::Zlib::Stream->new( deflateopts => { -Level => 9 } );
my $scalar = 'Blah Blah Blah';
my $compressed_array   = $filter->put( [ $scalar ] );
my $uncompressed_array = $filter->get( $compressed_array );

use POE qw(Filter::Stackable Filter::Line Filter::Zlib::Stream);

my ($filter) = POE::Filter::Stackable->new();
$filter->push( POE::Filter::Zlib::Stream->new(),
               POE::Filter::Line->new( InputRegexp => '\015?\012', OutputLiteral => "\015\012" ),

(okay so yes, the last line in the original literally just trails off with a dangling comma and no closing paren — I'm not touching it, that's her choice, we respect it 💅)

---

🌈 DESCRIPTION 🌈

POE::Filter::Zlib::Stream gives you a POE filter that does compression/uncompression using Compress::Zlib. It's built to vibe with POE::Filter::Stackable. 🫶

Unlike POE::Filter::Zlib, this one uses deflate and inflate — not the higher-level compress and uncompress. So it's lowkey the raw, streamier cousin.

Ideal for streaming compressed data over sockets. ✨ main character networking energy

---

🎀 NAME 🎀

(again, yes, we said what we said)

POE::Filter::Zlib::Stream — A POE filter wrapped around Compress::Zlib deflate and inflate. 🦋

---

👑 CONSTRUCTOR 👑

new

Creates a new POE::Filter::Zlib::Stream object. Takes some optional arguments:

• deflateopts — a hashref of options to be passed to deflateInit(); 🍓
• inflateopts — a hashref of options to be passed to inflateInit(); 🧚
• flushtype — the type of flush to use when flushing the compressed data. Defaults to Z_SYNC_FLUSH so you get a single stream, but if there is a POE::Filter::Zlib on the other end, you want to set this to Z_FINISH. (read that twice, bestie — mismatched flush types on either end is a whole situationship you do NOT want 💀)

Consult Compress::Zlib for more detail regarding these options. 📚

---

💅 METHODS 💅

get

get_one_start

get_one

Takes an arrayref which is contains streams of compressed input. Returns an arrayref of uncompressed streams. 🌸

get_pending

Returns any data in a filter's input buffer. The filter's input buffer is not cleared, however. (so like… peeking. she's looking but not touching 🙈)

put

Takes an arrayref containing streams of uncompressed output, returns an arrayref of compressed streams. 🔥

clone

Makes a copy of the filter, and clears the copy's buffer. ✨

---

⭐ AUTHOR ⭐

Chris Williams <chris@bingosnet.co.uk>

Martijn van Beers <martijn@cpan.org>

---

🌼 LICENSE 🌼

Copyright © Chris Williams and Martijn van Beers.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

---

🔍 SEE ALSO 🔍

• POE::Filter
• Compress::Zlib
• POE::Filter::Stackable

---

🫶 AUTHORS 🫶

1. Chris Williams <chris@bingosnet.co.uk>
2. Martijn van Beers

---

💜 COPYRIGHT AND LICENSE 💜

This software is copyright (c) 2017 by Chris Williams and Martijn van Beers.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

---

k bye bestie, go compress something 💖 this was POE::Fi...::Stream(3) from the User Contributed Perl Documentation, version 2.04, and the page footer said perl v5.42.0 dated 2025-07-25 — slay, that's a wrap ✨🎀🦋