Compre...ontext(3pm)

💖 NAME 💖

omg hi bestie, welcome to Compre...ontext(3pm) from the User Contributed Perl Documentation. The actual name-and-what-it-is situation is literally this: Compress::Stream::Zstd::CompressionContext — Zstd compression context. That's the whole NAME vibe, periodt. 💅

---

✨ SYNOPSIS ✨

use Compress::Stream::Zstd::CompressionContext;

my $cctx = Compress::Stream::Zstd::CompressionContext->new;
my $dest = $cctx->compress($src, $level);

That's the quick-start group chat, bestie: make a context, then compress. Slay. 🫶

---

🌸 DESCRIPTION 🌸

Okay so first things first: this module is marked (Experimental) — yes, the manual literally says (Experimental), so go in knowing that. The Compress::Stream::Zstd::CompressionContext module provides Zstd compression context. That's the whole description, but it's a real one, no cap. 🦋

---

🎀 METHODS 🎀

💅 Compress::Stream::Zstd::CompressionContext->new()

The page also lists this exact thing right here: :Compress::Stream::Zstd::CompressionContext.

This method creates an instance of Compress::Stream::Zstd::CompressionContext — constructor energy, main character behavior. 🎀

🌸 $cctx->compress($source [, $level])

Compresses the given buffer and returns the resulting bytes. If something goes sideways, on error undef is returned — that's your little "nope" signal. 😭

🦋 $cctx->compress_using_dict($source, $dict)

Compresses the given buffer using compression dictionary and returns the resulting bytes. On error undef is returned. The $dict is doing its little dictionary moment, iykyk. ✨

---

🌈 SEE ALSO 🌈

The one and only reference on the page: <http://www.zstd.net/> — go absorb the Zstd lore, bestie. 🔥

---

👑 LICENSE 👑

Legal bestie moment incoming — here's the exact license text, all of it, no skips, because copyright is not a vibe to mess with:

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 ⭐

Written by Jiro Nishiguchi <jiro@cpan.org>.

Zstandard by Facebook, Inc. — iconic collaborators, honestly. 👑

---

okay that's the whole page, bestie — footer vibes are perl v5.40.0, dated 2024-07-18, and the page is Compre...ontext(3pm). byeee 💖