README.md
1[](https://travis-ci.org/spiritloose/Compress-Zstd)
2# NAME
3
4Compress::Zstd - Perl interface to the Zstd (Zstandard) (de)compressor
5
6# SYNOPSIS
7
8 use Compress::Zstd;
9
10 my $compressed = compress($bytes);
11 my $decompressed = decompress($compressed);
12
13# DESCRIPTION
14
15The Compress::Zstd module provides an interface to the Zstd (de)compressor.
16
17# FUNCTIONS
18
19## compress($source \[, $level\])
20
21Compresses the given buffer and returns the resulting bytes. The input
22buffer can be either a scalar or a scalar reference.
23
24On error undef is returned.
25
26## compress\_mt($source, $num\_threads \[, $level\])
27
28Multi-threaded version of the `compress` function.
29
30Note that this function uses experimental API of Zstandard.
31
32## decompress($source)
33
34## uncompress($source)
35
36Decompresses the given buffer and returns the resulting bytes. The input
37buffer can be either a scalar or a scalar reference.
38
39On error (in case of corrupted data) undef is returned.
40
41# CONSTANTS
42
43## ZSTD\_VERSION\_NUMBER
44
45## ZSTD\_VERSION\_STRING
46
47## ZSTD\_MAX\_CLEVEL
48
49# SEE ALSO
50
51[http://www.zstd.net/](http://www.zstd.net/)
52
53# LICENSE
54
55 Copyright (c) 2016, Jiro Nishiguchi
56 All rights reserved.
57
58 Redistribution and use in source and binary forms, with or without modification,
59 are permitted provided that the following conditions are met:
60
61 1. Redistributions of source code must retain the above copyright notice, this
62 list of conditions and the following disclaimer.
63
64 2. Redistributions in binary form must reproduce the above copyright notice,
65 this list of conditions and the following disclaimer in the documentation
66 and/or other materials provided with the distribution.
67
68 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
69 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
70 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
71 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
72 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
73 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
74 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
75 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
76 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
77 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
78
79# AUTHOR
80
81Jiro Nishiguchi <jiro@cpan.org>
82
83Zstandard by Facebook, Inc.
84
){kind=link}