IO::UNCOMPRESS::UNZIP(3perl)

📦

version 5.44.0 · 14 versions

💖 NAME 💖

Bestie, this is the 3perl manual page for IO::Uncompress::Unzip — and what it does is read zip files and zip buffers. That's it. That's the whole job. 🦋

✨ SYNOPSIS ✨

Okay so here's how you get in the door — pull in the function and the error variable:

use IO::Uncompress::Unzip qw(unzip $UnzipError) ;

my $status = unzip $input => $output [,OPTS]
    or die "unzip failed: $UnzipError\n";

Or if you'd rather have the object version, make one:

my $z = IO::Uncompress::Unzip->new( $input [OPTS] )
    or die "unzip failed: $UnzipError\n";

Then it's just vibes and method calls, all of these existing as methods on $z:

$status = $z->read($buffer)
$status = $z->read($buffer, $length)
$status = $z->read($buffer, $length, $offset)
$line = $z->getline()
$char = $z->getc()
$char = $z->ungetc()
$char = $z->opened()

$status = $z->inflateSync()

$data = $z->trailingData()
$status = $z->nextStream()
$data = $z->getHeaderInfo()
$z->tell()
$z->seek($position, $whence)
$z->binmode()
$z->fileno()
$z->eof()
$z->close()

$UnzipError ;

# IO::File mode

And because this module is literally that girl, it also does the IO::File thing — bareword-style filehandle ops all work on $z:

<$z>
read($z, $buffer);
read($z, $buffer, $length);
read($z, $buffer, $length, $offset);
tell($z)
seek($z, $position, $whence)
binmode($z)
fileno($z)
eof($z)
close($z)

🌸 DESCRIPTION 🌸

Okay so real talk: this module hands you a Perl interface that lets you read zlib files and buffers. Yes, the description literally says zlib, and no, I'm not explaining that, we're just reading it as written. 😌

If you're on the writing side of things — zip files, zip buffers, the whole to-write situation — that's a different module, bestie. Go say hi to IO::Compress::Zip instead. 🫶

The main character purpose of this module? Streaming read access to zip files and buffers. Streaming. Read. Access. That's the whole assignment. ✨

Right now, at present, these are the compression methods IO::Uncompress::Unzip supports:

Store (0) — the no-compression-just-vibes option 🎀
Deflate (8) — the classic
Bzip2 (12) — and heads up: to read Bzip2 content, the module IO::Uncompress::Bunzip2 has to be installed. No module, no Bzip2. Periodt.
Lzma (14) — and again, to read LZMA content, the module IO::Uncompress::UnLzma must be installed. 👑
Xz (95) — to read Xz content, the module IO::Uncompress::UnXz must be installed. 💅
Zstandard (93) — and to read Zstandard content, the module IO::Uncompress::UnZstd must be installed. 🦋

Not me noticing that pretty much every fancy method needs its own companion module installed first. The vibe check is: check your dependencies, bestie. 💀

✨ Functional Interface ✨

okay so bestie, there's a top-level function called unzip that's here to carry out "one-shot" uncompression between buffers and/or files. For finer control over the uncompression process, go check out the OO Interface section. 💅

           use IO::Uncompress::Unzip qw(unzip $UnzipError) ;

           unzip $input_filename_or_reference => $output_filename_or_reference [,OPTS]
               or die "unzip failed: $UnzipError\n";

The functional interface needs Perl5.005 or better. no cap. 🫶

unzip `$input_filename_or_reference` => `$output_filename_or_reference` [, OPTS]

unzip expects at least two parameters, $input_filename_or_reference and $output_filename_or_reference, and zero or more optional parameters (see "Optional Parameters"). 💖

The $input_filename_or_reference parameter

The parameter, $input_filename_or_reference, is used to define the source of the compressed data. It can take one of the following forms:

A filename — If the $input_filename_or_reference parameter is a simple scalar, it is assumed to be a filename. This file will be opened for reading and the input data will be read from it. 🌸
A filehandle — If the $input_filename_or_reference parameter is a filehandle, the input data will be read from it. The string - can be used as an alias for standard input. 🎀
A scalar reference — If $input_filename_or_reference is a scalar reference, the input data will be read from $$input_filename_or_reference. ✨
An array reference — If $input_filename_or_reference is an array reference, each element in the array must be a filename. The input data will be read from each file in turn. The complete array will be walked to ensure that it only contains valid filenames before any data is uncompressed. 🔥
An Input FileGlob string — If $input_filename_or_reference is a string that is delimited by the characters < and > unzip will assume that it is an input fileglob string. The input is the list of files that match the fileglob. See File::GlobMapper for more details. 🌈

If the $input_filename_or_reference parameter is any other type, undef will be returned. 💀

The $output_filename_or_reference parameter

The parameter $output_filename_or_reference is used to control the destination of the uncompressed data. This parameter can take one of these forms.

A filename — If the $output_filename_or_reference parameter is a simple scalar, it is assumed to be a filename. This file will be opened for writing and the uncompressed data will be written to it. 💜
A filehandle — If the $output_filename_or_reference parameter is a filehandle, the uncompressed data will be written to it. The string - can be used as an alias for standard output. 🦋
A scalar reference — If $output_filename_or_reference is a scalar reference, the uncompressed data will be stored in $$output_filename_or_reference. 💖
An Array Reference — If $output_filename_or_reference is an array reference, the uncompressed data will be pushed onto the array. 👑
An Output FileGlob — If $output_filename_or_reference is a string that is delimited by the characters < and > unzip will assume that it is an output fileglob string. The output is the list of files that match the fileglob. When $output_filename_or_reference is an fileglob string, $input_filename_or_reference must also be a fileglob string. Anything else is an error. See File::GlobMapper for more details. ⭐

If the $output_filename_or_reference parameter is any other type, undef will be returned. 😭

Notes 📝

When $input_filename_or_reference maps to multiple compressed files/buffers and $output_filename_or_reference is a single file/buffer, after uncompression $output_filename_or_reference will contain a concatenation of all the uncompressed data from each of the input files/buffers. 🧚

Optional Parameters 🎀

The optional parameters for the one-shot function unzip are (for the most part) identical to those used with the OO interface defined in the Constructor Options section. The exceptions are listed below. 💅

AutoClose => 0|1 — This option applies to any input or output data streams to unzip that are filehandles. If AutoClose is specified, and the value is true, it will result in all input and/or output filehandles being closed once unzip has completed. This parameter defaults to 0. ✨
BinModeOut => 0|1 — This option is now a no-op. All files will be written in binmode. 💀
Append => 0|1 — The behaviour of this option is dependent on the type of output data stream. 🌸
- A Buffer — If Append is enabled, all uncompressed data will be append to the end of the output buffer. Otherwise the output buffer will be cleared before any uncompressed data is written to it. 🎀
- A Filename — If Append is enabled, the file will be opened in append mode. Otherwise the contents of the file, if any, will be truncated before any uncompressed data is written to it. 💜
- A Filehandle — If Append is enabled, the filehandle will be positioned to the end of the file via a call to seek before any uncompressed data is written to it. Otherwise the file pointer will not be moved. 🦋
- When Append is specified, and set to true, it will append all uncompressed data to the output data stream. 🔥
- So when the output is a filehandle it will carry out a seek to the eof before writing any uncompressed data. If the output is a filename, it will be opened for appending. If the output is a buffer, all uncompressed data will be appended to the existing buffer. 🌈
- Conversely when Append is not specified, or it is present and is set to false, it will operate as follows. ⭐
- When the output is a filename, it will truncate the contents of the file before writing any uncompressed data. If the output is a filehandle its position will not be changed. If the output is a buffer, it will be wiped before any uncompressed data is output. 💅
- Defaults to 0. 👑
MultiStream => 0|1 — If the input file/buffer contains multiple compressed data streams, this option will uncompress the whole lot as a single data stream. Defaults to 0. 🧚
TrailingData => $scalar — Returns the data, if any, that is present immediately after the compressed data stream once uncompression is complete. This option can be used when there is useful information immediately following the compressed data stream, and you don't know the length of the compressed data stream. If the input is a buffer, trailingData will return everything from the end of the compressed data stream to the end of the buffer. If the input is a filehandle, trailingData will return the data that is left in the filehandle input buffer once the end of the compressed data stream has been reached. You can then use the filehandle to read the rest of the input file. Don't bother using trailingData if the input is a filename. If you know the length of the compressed data stream before you start uncompressing, you can avoid having to use trailingData by setting the InputLength option. 💖

OneShot Examples 🌟

Say you have a zip file, file1.zip, that only contains a single member, you can read it and write the uncompressed data to the file file1.txt like this. 🦋

           use strict ;
           use warnings ;
           use IO::Uncompress::Unzip qw(unzip $UnzipError) ;

           my $input = "file1.zip";
           my $output = "file1.txt";
           unzip $input => $output
               or die "unzip failed: $UnzipError\n";

If you have a zip file that contains multiple members and want to read a specific member from the file, say data1, use the Name option. 💅

           use strict ;
           use warnings ;
           use IO::Uncompress::Unzip qw(unzip $UnzipError) ;

           my $input = "file1.zip";
           my $output = "file1.txt";
           unzip $input => $output, Name => "data1"
               or die "unzip failed: $UnzipError\n";

Alternatively, if you want to read the data1 member into memory, use a scalar reference for the output parameter. ✨

           use strict ;
           use warnings ;
           use IO::Uncompress::Unzip qw(unzip $UnzipError) ;

           my $input = "file1.zip";
           my $output ;
           unzip $input => \$output, Name => "data1"
               or die "unzip failed: $UnzipError\n";
           # $output now contains the uncompressed data

To read from an existing Perl filehandle, $input, and write the uncompressed data to a buffer, $buffer. 🎀

           use strict ;
           use warnings ;
           use IO::Uncompress::Unzip qw(unzip $UnzipError) ;
           use IO::File ;

           my $input = IO::File->new( "<file1.zip" )
               or die "Cannot open 'file1.zip': $!\n" ;
           my $buffer ;
           unzip $input => \$buffer
               or die "unzip failed: $UnzipError\n";

💖 OO Interface 💖

okay bestie, now we're leveling up from the functional interface to the glow-up object-oriented one. same zip energy, but with a whole object you can carry around like a little emotional support filehandle. 💅

✨ Constructor ✨

the format of the constructor for IO::Uncompress::Unzip is shown below

my $z = IO::Uncompress::Unzip->new( $input [OPTS] )
    or die "IO::Uncompress::Unzip failed: $UnzipError\n";

the constructor takes one mandatory parameter, $input, defined below, and zero or more OPTS, defined in "Constructor Options". no cap. 🫶

returns an IO::Uncompress::Unzip object on success and undef on failure. the variable $UnzipError will contain an error message on failure. 😭

if you are running Perl 5.005 or better the object, $z, returned from IO::Uncompress::Unzip can be used exactly like an IO::File filehandle. this means that all normal input file operations can be carried out with $z. for example, to read a line from a compressed file/buffer you can use either of these forms

$line = $z->getline();
$line = <$z>;

below is a simple example of using the OO interface to read the compressed file "myfile.zip" and write its contents to stdout. 🌸

my $filename = "myfile.zip";
my $z = IO::Uncompress::Unzip->new($filename)
    or die "IO::Uncompress::Unzip failed: $UnzipError\n";

while (<$z>) {
    print $_;
}
$z->close();

see "EXAMPLES" for further examples. ✨

the mandatory parameter $input is used to determine the source of the compressed data. this parameter can take one of three forms. 👑

🌈 A filename 🌈

if the $input parameter is a scalar, it is assumed to be a filename. this file will be opened for reading and the compressed data will be read from it. 📂

🌈 A filehandle 🌈

if the $input parameter is a filehandle, the compressed data will be read from it. the string '-' can be used as an alias for standard input. 🫶

🌈 A scalar reference 🌈

if $input is a scalar reference, the compressed data will be read from $$input. 💜

🛠️ Constructor Options 🛠️

the option names defined below are case insensitive and can be optionally prefixed by a '-'. so all of the following are valid

-AutoClose
-autoclose
AUTOCLOSE
autoclose

OPTS is a combination of the following options:

Name => "membername" — opens membername from the zip file for reading. like, you point at a member and it's yours. 👑
Efs => 0| 1 — when this option is set to true AND the zip archive being read has the "Language Encoding Flag" (EFS) set, the member name is assumed to be encoded in UTF-8. ✨

if the member name in the zip archive is not valid UTF-8 when this option is true, the script will die with an error message. 💀

note that this option only works with Perl 5.8.4 or better. this option defaults to false.

AutoClose => 0|1 — this option is only valid when the $input parameter is a filehandle. if specified, and the value is true, it will result in the file being closed once either the close method is called or the IO::Uncompress::Unzip object is destroyed. 🫶

this parameter defaults to 0.

MultiStream => 0|1 — treats the complete zip file/buffer as a single compressed data stream. when reading in multi-stream mode each member of the zip file/buffer will be uncompressed in turn until the end of the file/buffer is encountered. 🌈

this parameter defaults to 0.

Prime => $string — this option will uncompress the contents of $string before processing the input file/buffer. 🧚

this option can be useful when the compressed data is embedded in another file/data structure and it is not possible to work out where the compressed data begins without having to read the first few bytes. if this is the case, the uncompression can be primed with these bytes using this option.

Transparent => 0|1 — if this option is set and the input file/buffer is not compressed data, the module will allow reading of it anyway. 👀

in addition, if the input file/buffer does contain compressed data and there is non-compressed data immediately following it, setting this option will make this module treat the whole file/buffer as a single data stream.

this option defaults to 1.

BlockSize => $num — when reading the compressed input data, IO::Uncompress::Unzip will read it in blocks of $num bytes. 📦

this option defaults to 4096.

InputLength => $size — when present this option will limit the number of compressed bytes read from the input file/buffer to $size. this option can be used in the situation where there is useful data directly after the compressed data stream and you know beforehand the exact length of the compressed data stream. 🎯

this option is mostly used when reading from a filehandle, in which case the file pointer will be left pointing to the first byte directly after the compressed data stream.

this option defaults to off.

Append => 0|1 — this option controls what the read method does with uncompressed data. 📝

if set to 1, all uncompressed data will be appended to the output parameter of the read method.

if set to 0, the contents of the output parameter of the read method will be overwritten by the uncompressed data.

defaults to 0.

Strict => 0|1 — this option controls whether the extra checks defined below are used when carrying out the decompression. when Strict is on, the extra tests are carried out, when Strict is off they are not. 🕵️

the default for this option is off.

✨ Methods ✨

read 💅

Okay so bestie, usage first:

$status = $z->read($buffer)

What this does: it reads one block of compressed data — and the block size is decided by the Buffer option you set in the constructor — uncompresses that block, and dumps all the uncompressed data into $buffer. Now, if you set the Append parameter in the constructor, that uncompressed data gets appended onto $buffer. If you didn't, then $buffer gets straight-up overwritten. No warning, just vibes. 🙈

Returns the number of uncompressed bytes written into $buffer. Returns zero at eof, and a negative number if something went wrong.

read (the sequel) 💖

Usage:

$status = $z->read($buffer, $length)
$status = $z->read($buffer, $length, $offset)

$status = read($z, $buffer, $length)
$status = read($z, $buffer, $length, $offset)

This one attempts to read exactly $length bytes of uncompressed data into $buffer.

The main glow-up between this version and the previous one is that this one actually tries to give you exactly $length bytes. The only times it won't manage that are if it hits end-of-file or an IO error sneaks in. That's it, that's the whole exception list.

Returns the number of uncompressed bytes written to $buffer, zero if eof, or a negative number if error. Same deal as before. ✨

getline 🌸

Usage:

$line = $z->getline()
$line = <$z>

Reads a single line. That's the whole thing, she's simple and she's serving.

This method fully supports using the $/ variable (or $INPUT_RECORD_SEPARATOR, or $RS when English is in use) to decide what counts as an end of line. Paragraph mode, record mode, and file slurp mode are all supported. So whatever line-reading vibe you're on, she gets it.

getc 🍓

Usage:

$char = $z->getc()

Read a single character. One (1) character. No more. Periodt.

ungetc 🦋

Usage:

$char = $z->ungetc($string)

inflateSync ⭐

Usage:

$status = $z->inflateSync()

TODO. Yeah bestie, that's literally what the docs say. We move. 💀

getHeaderInfo 👑

Usage:

$hdr  = $z->getHeaderInfo();
@hdrs = $z->getHeaderInfo();

This method hands you either a hash reference (if you called it in scalar context) or a list of hash references (if you called it in array context). Either way, that info describes every single header field in the compressed data stream(s). All the receipts. 🧾

tell 💜

Usage:

$z->tell()
tell $z

Returns the uncompressed file offset.

eof 🌈

Usage:

$z->eof();
eof($z);

Returns true if the end of the compressed input stream has been reached. That's the vibe check — are we done here or not.

seek 🎀

$z->seek($position, $whence);
seek($z, $position, $whence);

This gives you a sub-set of seek functionality, with one big restriction: it is only legal to seek forward in the input file/buffer. Trying to seek backward is a fatal error. Do not test her. 💀

Heads up, bestie: the way seek is implemented in this module does not give you true random access to a compressed file/buffer. It works by uncompressing data from the current offset in the file/buffer all the way until it reaches the uncompressed offset you asked for in seek's parameters. For very small files this might be totally fine. For large files it could cause an unacceptable delay. Choose wisely. 😭

The $whence parameter takes one of the usual values, namely SEEK_SET, SEEK_CUR or SEEK_END.

Returns 1 on success, 0 on failure.

binmode 🧚

Usage:

$z->binmode
binmode $z ;

This is a noop provided for completeness. She does nothing and she's not sorry about it. 💅

opened 💖

$z->opened()

Returns true if the object currently refers to an opened file/buffer.

autoflush ✨

my $prev = $z->autoflush()
my $prev = $z->autoflush(EXPR)

If the $z object is associated with a file or a filehandle, this method returns the current autoflush setting for the underlying filehandle. If EXPR is present, and it's non-zero, it'll enable flushing after every single write/print operation. Very eager. Very on top of things.

If $z is associated with a buffer, this method has no effect and always returns undef.

Ngl, note that the special variable $| cannot be used to set or retrieve the autoflush setting here. She doesn't play that game. 🚫

input_line_number 🌸

$z->input_line_number()
$z->input_line_number(EXPR)

Returns the current uncompressed line number. If EXPR is present, it has the effect of setting the line number. But — and this is important, bestie — setting the line number does not change the current position within the file/buffer being read. It's purely cosmetic-ish. The numbers move, the pointer does not.

The contents of $/ are used to determine what counts as a line terminator.

fileno 🦋

$z->fileno()
fileno($z)

If the $z object is associated with a file or a filehandle, fileno will return the underlying file descriptor. Once the close method has been called, fileno will return undef. Gone. Poof. 💨

If the $z object is associated with a buffer, this method returns undef.

close 💅

$z->close() ;
close $z ;

Closes the output file/buffer.

For most versions of Perl this method gets automatically invoked when the IO::Uncompress::Unzip object is destroyed — whether that's you explicitly destroying it or the variable holding the reference just going out of scope. The exceptions are Perl versions 5.005 through 5.00504 and 5.8.0. In those cases close still gets called automatically, but not until global destruction of all live objects, aka when the program is terminating. So like... eventually. 😬

So fr fr, if you want your scripts to run on all versions of Perl, call close explicitly and don't rely on automatic closing. Do it yourself, babe. Be the main character of your own cleanup. 👑

Returns true on success, otherwise 0.

If the AutoClose option was enabled when the IO::Uncompress::Unzip object was created, and the object is associated with a file, the underlying file gets closed too.

nextStream 🔥

Usage:

my $status = $z->nextStream();

Skips to the next compressed data stream in the input file/buffer. If a new compressed data stream is found, the eof marker gets cleared and $. will be reset to 0. Fresh start, clean slate. ✨

If trailing data is present immediately after the zip archive and the Transparent option is enabled, this method will consider that trailing data to be another member of the zip archive. Surprise member!

Returns 1 if a new stream was found, 0 if none was found, and -1 if an error was encountered.

trailingData 🌈

Usage:

my $data = $z->trailingData();

Returns the data, if any, that's hanging out immediately after the compressed data stream once uncompression is complete. It only makes sense to call this method after you've hit the end of the compressed data stream. Don't call it early, it won't know what you want.

This is useful when there's genuinely useful info sitting right after the compressed data stream, and you don't know the length of that stream.

If the input is a buffer, trailingData will return everything from the end of the compressed data stream to the end of the buffer. The whole rest of it.

If the input is a filehandle, trailingData will return the data left in the filehandle input buffer once the end of the compressed data stream has been reached. After that you can use the filehandle to read the rest of the input file.

Don't bother using trailingData if the input is a filename. Just... don't. 🙈

If you already know the length of the compressed data stream before you start uncompressing, you can skip trailingData entirely by setting the InputLength option in the constructor. Efficient queen behavior.

🎀 Importing 🎀

No symbolic constants are required by IO::Uncompress::Unzip at present. None. Zero. Nada. 💖

:all — imports unzip and $UnzipError. Same as doing this:

use IO::Uncompress::Unzip qw(unzip $UnzipError) ;

✨ EXAMPLES ✨

Simple Read 🌸

So say you have a zip file, file1.zip, and it only contains a single member. You can read it and write the uncompressed data out to the file file1.txt like this:

use strict ;
use warnings ;
use IO::Uncompress::Unzip qw(unzip $UnzipError) ;

my $filename = "file1.zip";
my $z = IO::Uncompress::Unzip->new($filename)
    or die "IO::Uncompress::Unzip failed: $UnzipError\n";
open my $out, ">", "file1.txt";

while (<$z>) {
    print $out $_;
}
$z->close();

And if you have a zip file containing multiple members and you want to read one specific member from the file — say, data1 — you use the Name option when constructing the

use strict ;
use warnings ;
use IO::Uncompress::Unzip qw(unzip $UnzipError) ;

my $filename = "file1.zip";
my $z = IO::Uncompress::Unzip->new($filename, Name => "data1")
    or die "IO::Uncompress::Unzip failed: $UnzipError\n";

Walking through a zip file 👑

The code below can be used to traverse a zip file, one compressed data stream at a time. Very systematic, very cunt. 💅

use IO::Uncompress::Unzip qw($UnzipError);

my $zipfile = "somefile.zip";
my $u = IO::Uncompress::Unzip->new( $zipfile )
    or die "Cannot open $zipfile: $UnzipError";

my $status;
for ($status = 1; $status > 0; $status = $u->nextStream())
{

    my $name = $u->getHeaderInfo()->{Name};
    warn "Processing member $name\n" ;

    my $buff;
    while (($status = $u->read($buff)) > 0) {
        # Do something here
    }

    last if $status < 0;
}

die "Error processing $zipfile: $!\n"
    if $status < 0 ;

Each individual compressed data stream is read until the logical end-of-file is reached. Then nextStream gets called. That skips to the start of the next compressed data stream and clears the end-of-file flag. Rinse and repeat, bestie. 🔁

It's also worth noting that nextStream can be called at any time — you don't have to wait until you've exhausted a compressed data stream before skipping to the next one. She's flexible like that. ✨

Unzipping a complete zip file to disk 🦋

Daniel S. Sterling has written a script that uses IO::Uncompress::UnZip to read a zip file and unzip its contents to disk.

The script is available from <https://gist.github.com/eqhmcow/5389877>

Working with Net::FTP 💖

See IO::Compress::FAQ

🌈 SUPPORT 🌈

General feedback, questions and bug reports should be sent to <https://github.com/pmqs/IO-Compress/issues> (that one's preferred 💜) or <https://rt.cpan.org/Public/Dist/Display.html?Name=IO-Compress>.

🌸 SEE ALSO 🌸

ok bestie, here's the whole squad — everything that vibes with this module:

Compress::Zlib, IO::Compress::Gzip, IO::Uncompress::Gunzip, IO::Compress::Deflate, IO::Uncompress::Inflate, IO::Compress::RawDeflate, IO::Uncompress::RawInflate, IO::Compress::Bzip2, IO::Uncompress::Bunzip2, IO::Compress::Lzma, IO::Uncompress::UnLzma, IO::Compress::Xz, IO::Uncompress::UnXz, IO::Compress::Lzip, IO::Uncompress::UnLzip, IO::Compress::Lzop, IO::Uncompress::UnLzop, IO::Compress::Lzf, IO::Uncompress::UnLzf, IO::Compress::Zstd, IO::Uncompress::UnZstd, IO::Uncompress::AnyInflate, IO::Uncompress::AnyUncompress
IO::Compress::FAQ
File::GlobMapper, Archive::Zip, Archive::Tar, IO::Zlib

✨ the lore ✨ — if you wanna read the actual specs (iykyk):

For RFC 1950, 1951 and 1952 see <https://datatracker.ietf.org/doc/html/rfc1950>, <https://datatracker.ietf.org/doc/html/rfc1951> and <https://datatracker.ietf.org/doc/html/rfc1952>

The zlib compression library was written by Jean-loup Gailly "gzip@prep.ai.mit.edu" and Mark Adler "madler@alumni.caltech.edu". legends, honestly 💜

The primary site for the zlib compression library is <http://www.zlib.org>.

The primary site for the zlib-ng compression library is <https://github.com/zlib-ng/zlib-ng>.

The primary site for gzip is <http://www.gzip.org>.

👑 AUTHOR 👑

This module was written by Paul Marquess, "pmqs@cpan.org". main character energy fr fr 🎀

📜 MODIFICATION HISTORY 📜

See the Changes file. that's where the receipts live bestie

🫶 COPYRIGHT AND LICENSE 🫶

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

✨ that's a wrap on the whole page ✨ this lil' slice came straight out of perl v5.44.0, dated 2026-10-17, under the IO::Un...::Unzip(3perl) header — go hydrate, then go unzip something slay 💅🦋💖

📦 where this page comes from

arch rolling: perl 5.44.0-1 · Artistic-1.0-Perl AND GPL-1.0-or-later
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-11-03: a language model's rewrite of the original, under its terms

IO::UNCOMPRESS::UNZIP(3perl)

💖 NAME 💖

✨ SYNOPSIS ✨

🌸 DESCRIPTION 🌸

✨ Functional Interface ✨

unzip $input_filename_or_reference => $output_filename_or_reference [, OPTS]

Notes 📝

Optional Parameters 🎀

OneShot Examples 🌟

💖 OO Interface 💖

✨ Constructor ✨

🌈 A filename 🌈

🌈 A filehandle 🌈

🌈 A scalar reference 🌈

🛠️ Constructor Options 🛠️

✨ Methods ✨

read 💅

read (the sequel) 💖

getline 🌸

getc 🍓

ungetc 🦋

inflateSync ⭐

getHeaderInfo 👑

tell 💜

eof 🌈

seek 🎀

binmode 🧚

opened 💖

autoflush ✨

input_line_number 🌸

fileno 🦋

close 💅

nextStream 🔥

trailingData 🌈

🎀 Importing 🎀

✨ EXAMPLES ✨

Simple Read 🌸

Walking through a zip file 👑

Unzipping a complete zip file to disk 🦋

Working with Net::FTP 💖

🌈 SUPPORT 🌈

🌸 SEE ALSO 🌸

👑 AUTHOR 👑

📜 MODIFICATION HISTORY 📜

🫶 COPYRIGHT AND LICENSE 🫶

unzip `$input_filename_or_reference` => `$output_filename_or_reference` [, OPTS]