Compre...tionary(3pm)

💅 Compre...tionary — the Zstd decompression dictionary page, explained

ok so this is the manual for Compress::Stream::Zstd::DecompressionDictionary from the User Contributed Perl Documentation, bestie. it's a whole module about Zstd decompression dictionaries and honestly? kinda iconic. let's get into it ✨

---

🌸 NAME 🌸

Compress::Stream::Zstd::DecompressionDictionary — literally the Zstd decompression dictionary module. that's the whole vibe. 🎀

---

🦋 SYNOPSIS 🦋

ok here's how you actually use it, copy-paste energy:

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

my $ddict = Compress::Stream::Zstd::DecompressionDictionary->new_from_file($filename);
my $dctx = Compress::Stream::Zstd::DecompressionContext->new;
my $dest = $cctx->decompress_using_dict($src, $ddict);

load both modules, build a dictionary from a file with new_from_file, spin up a decompression context with new, then call decompress_using_dict on your source with the dict. that's the flow, no cap. 🫶

yes i'm keeping it exactly as written, $cctx and all — that's what the page says, so that's what you get. not me changing the source material 💀

---

✨ DESCRIPTION ✨

(Experimental) — so like, lowkey still in beta, be aware of that 👀

Compress::Stream::Zstd::DecompressionDictionary provides Zstd decompression dictionaries. that's it, that's the job. it holds the dictionary data so your decompressor knows what's up. 🔥

---

💖 METHODS 💖

🧚 Compress::Stream::Zstd::DecompressionDictionary->new($dict)

:Compress::Stream::Zstd::DecompressionDictionary

creates a new instance of Compress::Stream::Zstd::DecompressionDictionary. fresh object, who dis. ✨

🍓 Compress::Stream::Zstd::DecompressionDictionary->new_from_file($filename)

:Compress::Stream::Zstd::DecompressionDictionary

creates a new instance of Compress::Stream::Zstd::DecompressionDictionary from file — you point it at $filename and it does the loading for you. obsessed. 💅

---

👑 SEE ALSO 👑

Compress::Stream::Zstd — the parent module, go check it out iykyk 🌈

---

💜 LICENSE 💜

ok legal era, pay attention bestie:

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.

tl;dr: BSD-style, keep the copyright notice, no warranty, don't come for them if it breaks. standard legal bestie behaviour 🫶

---

⭐ AUTHOR ⭐

Jiro Nishiguchi <jiro@cpan.org> — legend 💖

Zstandard by Facebook, Inc. — also legends, respectfully 👑

---

anyway that's the whole page, you're now officially a Zstd decompression dictionary understander, main character energy fr fr 🌸🦋💫

this was perl v5.40.0, dated 2024-07-18, closing out Compre...tionary(3pm) — mwah, bye bestie 💅🎀