NAME

Compress::Stream::Zstd::CompressionContext - Zstd compression context

SYNOPSIS

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

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

DESCRIPTION

(Experimental) The Compress::Stream::Zstd::CompressionContext module provides Zstd compression context.

METHODS

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

Create an instance of Compress::Stream::Zstd::CompressionContext.

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

Compresses the given buffer and returns the resulting bytes.

On error undef is returned.

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

Compresses the given buffer using compression dictionary and returns the resulting bytes.

On error undef is returned.

SEE ALSO

http://www.zstd.net/

LICENSE

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.