NAME
Compress::Stream::Zstd::Compressor - Zstd streaming compression
SYNOPSIS
use Compress::Stream::Zstd::Compressor qw(ZSTD_CSTREAM_IN_SIZE);
my $compressor = Compress::Stream::Zstd::Compressor->new($level);
while (read($fh, my $buffer, ZSTD_CSTREAM_IN_SIZE)) {
print $compressor->compress($buffer);
}
print $compressor->end;DESCRIPTION
The Compress::Stream::Zstd::Compressor module provides a streaming interface to the Zstd compressor.
METHODS
Compress::Stream::Zstd::Compressor->new([$level]) :Compress::Stream::Zstd::Compressor
Create an instance of Compress::Stream::Zstd::Compressor.
$compressor->init([$level]) :Undef
(re)init the compressor.
$compressor->compress($input) :Str
Consume input stream.
$compressor->flush() :Str
Flush whatever data remains within internal buffer.
$compressor->end() :Str
Instructs to finish a frame.
$compressor->set_parameter( PARAMETER => VALUE )
Sets one of the compressor’s internal parameters. PARAMETER is one of the parameter constants listed below.
CONSTANTS
ZSTD_CSTREAM_IN_SIZE
Recommended size for input buffer.
PARAMETER CONSTANTS
The following may be given to set_parameter():
ZSTD_c_windowLog
SEE ALSO
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.