Compre...ressor(3pm)

okay so bestie, welcome to the Compre...ressor(3pm) page — yes, it's a User Contributed Perl Documentation situation, and it's about to be a whole Zstd streaming compression moment. 💅

✨ NAME ✨

Compress::Stream::Zstd::Compressor — Zstd streaming compression. That's the name, that's the vibe, periodt.

🌈 SYNOPSIS 🌈

Here's the group-chat recipe, copied exactly because code is sacred:

use Compress::Stream::Zstd::Compressor qw(ZSTD_CSTREAM_IN_SIZE);

my $compressor = Compress::Stream::Zstd::Compressor->new($level);
while (read($fh, my $buffer, ZSTD_CSTREAM_IN_SIZE)) {
    print $compressor->compress($buffer);
}
print $compressor->end;

🦋 DESCRIPTION 🦋

The Compress::Stream::Zstd::Compressor module gives you a streaming interface to the Zstd compressor. That's the whole plot, no cap. It's giving "feed me chunks and I'll compress them" energy. ✨

🧚 METHODS 🧚

💖 Compress::Stream::Zstd::Compressor->new([$level])

The annotation is :Compress::Stream::Zstd::Compressor, and the move is: create an instance of Compress::Stream::Zstd::Compressor. Slay.

🔁 $compressor->init([$level]) :Undef

(re)init the compressor. That's it, bestie — the annotation says :Undef.

🫶 $compressor->compress($input) :Str

Consume input stream. Annotation: :Str. Feed it $input, get compressed string energy back.

🚿 $compressor->flush() :Str

Flush whatever data remains within internal buffer. Annotation: :Str. Don't leave that data hanging, bestie.

🎀 $compressor->end() :Str

Instructs to finish a frame. Annotation: :Str. Wrap it up, close the frame, bye. 👑

⚙️ $compressor->set_parameter( PARAMETER => VALUE )

Sets one of the compressor's internal parameters. PARAMETER is one of the parameter constants listed below, iykyk.

🌟 CONSTANTS 🌟

ZSTD_CSTREAM_IN_SIZE

Recommended size for input buffer. That's the constant, periodt. 🍓

🎛️ PARAMETER CONSTANTS 🎛️

The following may be given to set_parameter():

• "ZSTD_c_windowLog"

🔗 SEE ALSO 🔗

<http://www.zstd.net/> — that's the reference, go be nosy. 💜

📜 LICENSE 📜

okay legal bestie moment, here's the license in full, unedited glory so nobody comes for us:

Copyright (c) 2016, Jiro Nishiguchi
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

👑 AUTHOR 👑

• Jiro Nishiguchi <jiro@cpan.org>
• Zstandard by Facebook, Inc.

---

xoxo, signing off with perl v5.40.0, dated 2024-07-18, on the Compre...ressor(3pm) page — bye bestie! 💖✨