Compre...ontext(3pm)

💅 NAME

ok so bestie, welcome to Compress::Stream::Zstd::DecompressionContext — it's a Zstd decompression context, and yes that's the whole vibe. (This page comes to you via User Contributed Perl Documentation, iykyk 🫶)

---

✨ SYNOPSIS

use Compress::Stream::Zstd::DecompressionContext;

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

like yes, that's genuinely it, copy-paste energy 🌸

---

🦋 DESCRIPTION

(Experimental) — read that again, bestie, it's giving "we're still figuring things out" 💀

The Compress::Stream::Zstd::DecompressionContext module provides a Zstd decompression context. That's the whole job description. She's a specialist. She decompresses. Periodt. 👑

---

🎀 METHODS

⭐ Compress::Stream::Zstd::DecompressionContext->new()

:Compress::Stream::Zstd::DecompressionContext

Creates an instance of Compress::Stream::Zstd::DecompressionContext — your very own main character context object ✨

💖 $dctx->decompress($source)

Decompresses the buffer you hand it and returns the resulting bytes. Simple. Iconic. Slay. 🌈

⚠️ On error (like, in case of corrupted data), undef is returned. So please check your return value, bestie, don't just assume 😭

🦋 $dctx->decompress_using_dict($source, $dict)

Same deal, but it decompresses the given buffer using a decompression dictionary — and returns the resulting bytes. Dictionary girlies stay winning 🎀

⚠️ Again: on error (in case of corrupted data) undef is returned. Same warning, same energy. Guard your code fr fr 🙈

---

🌈 SEE ALSO

<http://www.zstd.net/> — go be nosy, bestie 👀

---

👑 LICENSE

ok legal moment, no skipping, here's the whole thing verbatim because copyright is not a vibe you 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

Jiro Nishiguchi <jiro@cpan.org> 💌

Zstandard by Facebook, Inc. 🔥

---

ok that's the whole page, bestie, you ate that 🍓 stay compressed (jk, stay decompressed) — mwah 💋

perl v5.40.0 · 2024-07-18 — that's the version and date, bookmark it, and the man page name is Compre...ontext(3pm) in case you forgot already 💜