The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Compress::Stream::Zstd::Decompressor - Zstd streaming decompression

SYNOPSIS

use Compress::Stream::Zstd::Decompressor qw(ZSTD_DSTREAM_IN_SIZE);

my $decompressor = Compress::Stream::Zstd::Decompressor->new;
while (read($fh, my $buffer, ZSTD_DSTREAM_IN_SIZE)) {
    print $decompressor->decompress($buffer);
}

DESCRIPTION

The Compress::Stream::Zstd::Decompressor module provides a streaming interface to the Zstd decompressor.

METHODS

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

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

$decompressor->init() :Undef

(re)init the decompressor.

$decompressor->decompress($input) :Str

Consume input stream.

$decompressor->set_parameter( PARAMETER => VALUE )

Sets one of the decompressor’s internal parameters. PARAMETER is one of the parameter constants listed below.

CONSTANTS

ZSTD_DSTREAM_IN_SIZE

Recommended size for input buffer.

PARAMETER CONSTANTS

The following may be given to set_parameter():

  • ZSTD_d_windowLogMax

SEE ALSO

Compress::Stream::Zstd

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.