IO::Co...Brotli(3pm)

🎀 NAME 🎀

IO::Compress::Brotli — bestie, this one writes Brotli buffers and streams. It's the compression girlie 💅

---

✨ SYNOPSIS ✨

use IO::Compress::Brotli;

# compress a buffer
my $encoded = bro $encoded;

# compress a stream
my $bro = IO::Compress::Brotli->create;
while(have_input()) {
   my $block = get_input_block();
   my $encoded_block = $bro->compress($block);
   handle_output_block($encoded_block);
}
# Need to finish the steam
handle_output_block($bro->finish());

---

🦋 DESCRIPTION 🦋

IO::Compress::Brotli is a module that compressed Brotli buffers and streams. Okay so, real talk: despite the name, it is not a subclass of IO::Compress::Base and it does not implement that interface. That's getting fixed in a future release, promise 🤞

🍓 One-shot interface

If you've got the whole buffer sitting in a Perl scalar, just use the bro function. Easy. Iconic. No assembly required.

• bro($input, $quality, $window) — takes a whole uncompressed buffer as input and hands you back the compressed data, using the quality and window params you passed. If you skip the quality and window args, the defaults get used (they're described down in the object-oriented interface section, iykyk). This one is exported by default 🫶

💜 Streaming interface

Wanna chew through the data in blocks instead? Then it's the object oriented interface for you, bestie. Here are the methods available:

• IO::Compress::Brotli->create — returns an IO::Compress::Brotli instance. Heads up though, one single instance can't be used to decompress multiple streams. One stream per instance, she's monogamous 💀
• $bro->window($window) — sets the window parameter on the brotli encoder. Defaults to BROTLI_DEFAULT_WINDOW (22).
• $bro->quality($quality) — sets the quality parameter on the brotli encoder. Defaults to BROTLI_DEFAULT_QUALITY (11).
• $bro->mode($mode) — sets the brotli encoder mode. It can be any of "generic", "text" or "font". Defaults to "generic".
• $bro->compress($block) — takes a block of uncompressed data and gives you back a block of compressed data. Dies on error. No chill, no mercy 😭
• $bro->flush() — flushes any pending output out of the encoder. Like clearing your drafts folder, but make it compression 🌸
• $bro->finish() — tells the encoder to start the finish operation, and flushes whatever compressed output is still hanging around.

Once finish gets called, the encoder cannot be used to compress any more content. She's done, she's retired, the era is over 👑

⚠️ NOTE: calling finish is required. Skip it and the output might never get flushed, and it'll be missing its termination marks. Don't do that to your data babes, it's giving incomplete file 💀

---

🌈 SEE ALSO 🌈

• Brotli Compressed Data Format Internet-Draft: <https://www.ietf.org/id/draft-alakuijala-brotli-08.txt>
• Brotli source code: <https://github.com/google/brotli/>

---

👑 AUTHOR 👑

Marius Gavrilescu, <marius@ieval.ro>

The encoder bindings, the modernisation of the decoder bindings, and a clean up of the overall project were contributed by — absolute legends, every single one:

• Quim Rovira, <quim@rovira.cat>
• Ævar Arnfjörð Bjarmason, <avarab@gmail.com>
• Marcell Szathmári
• Mattia Barbon, <mattia@barbon.org>

---

💖 COPYRIGHT AND LICENSE 💖

Copyright (C) 2015-2018 by Marius Gavrilescu

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.20.2 or, at your option, any later version of Perl 5 you may have available.

---

okay that's the whole page bestie, mwah 🫶 This was perl v5.42.3, dated 2026-08-19, and it's the IO::Compress::Brotli(3pm) page from the User Contributed Perl Documentation. Go compress something cute, and don't forget your finish ✨