IO::UNCOMPRESS::UNZIP(3pm)

📦

version 5.42.3 · 17 versions

💖 NAME 💖

IO::Uncompress::Unzip — the module that reads zip files and zip buffers. That's it, that's the whole vibe. It's from the Perl Programmers Reference Guide, which is giving official but make it cute.

✨ SYNOPSIS ✨

okay so here's the whole menu of things you can do, literally all the incantations, copy them exactly bestie:

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

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

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

$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

<$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)

like, yes there are a LOT of methods, but they're all your besties once you meet them, i promise 🫶

🦋 DESCRIPTION 🦋

So this module hands you a Perl interface that lets you read zlib files and buffers. Yes, it says zlib even though it's the zip module — i'm just telling you exactly what the page says, no cap. 💅

Now if you're trying to write zip files or buffers, that's a totally different main character — go check the companion module IO::Compress::Zip. She handles the writing, this one handles the reading. ✨

The whole entire point of this module, its ~purpose~, is to give you streaming read access to zip files and zip buffers. Streaming. Like you don't gotta load the whole thing in memory first, you just sip it as you go. Iconic behavior honestly. 🍓

🌸 Compression methods it can handle rn 🌸

At present, IO::Uncompress::Unzip ships support for these compression methods, and yes i'm giving you the exact numbers because numbers matter:

Store (0) — the no-compression compression, literally just vibes and raw bytes.
Deflate (8) — the classic, the everyday hero.
Bzip2 (12) — but heads up bestie, to actually read Bzip2 content, the module "IO::Uncompress::Bunzip2" has to be installed first. No module, no reading. 🎀
Lzma (14) — and to read LZMA content you need the module "IO::Uncompress::UnLzma" installed. Same deal.
Xz (95) — to read Xz content, the module "IO::Uncompress::UnXz" must be installed. you're sensing the pattern by now fr fr.
Zstandard (93) — to read Zstandard content, the module "IO::Uncompress::UnZstd" needs to be installed. 💜

lowkey the whole theme here is: every fancy compression method is a collab, and the collab partner module has to be on the system before it works 😭

more parts coming, don't go anywhere — we're just getting started 🌈

✨ Functional Interface ✨

Okay so there's a top-level function called unzip that does the whole "one-shot" thing — uncompressing between buffers and/or files in a single call, no object wrangling needed 💅. If you want finer control over the whole uncompression sitch, go peek at the "OO Interface" section instead.

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

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

Heads up bestie: the functional interface needs Perl5.005 or better — no vintage Perls allowed 🫶.

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

unzip wants at least two parameters — $input_filename_or_reference and $output_filename_or_reference — plus zero or more optional ones (scroll to "Optional Parameters" for those, iykyk).

The `$input_filename_or_reference` parameter

This param is literally the whole "where is the compressed data coming from" question. It can take one of these forms:

A filename — if $input_filename_or_reference is a simple scalar, it's assumed to be a filename. The file gets opened for reading and the input data gets read from it 📖.
A filehandle — if $input_filename_or_reference is a filehandle, the input data gets read from it. The string '-' works as an alias for standard input ✨.
A scalar reference — if $input_filename_or_reference is a scalar reference, the input data gets read from $$input_filename_or_reference.
An array reference — if $input_filename_or_reference is an array reference, every element in the array has to be a filename. The input data gets read from each file in turn. And the whole array gets walked to make sure it only contains valid filenames before any data is uncompressed — vibe check first, decompress second 🎀.
An Input FileGlob string — if $input_filename_or_reference is a string delimited by the characters < and >, unzip assumes it's an input fileglob string, and the input is the list of files that match the fileglob. See File::GlobMapper for more deets.

If $input_filename_or_reference is any other type, undef will be returned. Not a vibe, but that's the deal 💀.

The `$output_filename_or_reference` parameter

$output_filename_or_reference controls where the uncompressed data lands. It can take one of these forms:

A filename — if it's a simple scalar, it's assumed to be a filename. That file gets opened for writing and the uncompressed data gets written to it 🌸.
A filehandle — if it's a filehandle, the uncompressed data gets 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 gets stored in $$output_filename_or_reference.
An Array Reference — if $output_filename_or_reference is an array reference, the uncompressed data gets pushed onto the array 📚.
An Output FileGlob — if $output_filename_or_reference is a string delimited by the characters < and >, unzip assumes it's an output fileglob string, and the output is the list of files that match the fileglob. When $output_filename_or_reference is a fileglob string, $input_filename_or_reference must also be a fileglob string — anything else is an error, no cap 😭. See File::GlobMapper for more deets.

If $output_filename_or_reference 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, then after uncompression $output_filename_or_reference will contain a concatenation of all the uncompressed data from each of the input files/buffers. It's giving "everyone piles into one car" energy 🚗✨.

🎀 Optional Parameters 🎀

The optional params for the one-shot unzip function are (for the most part) identical to the ones used with the OO interface in the "Constructor Options" section. The exceptions are listed below — and yes, these are the important ones 👑

AutoClose => 0|1 — this one applies to any input or output data streams to unzip that are filehandles. If AutoClose is specified and the value is true, all input and/or output filehandles get closed once unzip has finished 🫶. Defaults to 0.
BinModeOut => 0|1 — bestie this one is now a no-op. All files will be written in binmode. It's giving "retired icon" 💅.
Append => 0|1 — the behaviour here depends on the type of output data stream:
- A Buffer — if Append is enabled, all uncompressed data gets appended to the end of the output buffer. Otherwise the output buffer gets cleared before any uncompressed data is written to it.
- A Filename — if Append is enabled, the file gets opened in append mode. Otherwise the contents of the file, if any, get truncated before any uncompressed data is written to it.
- A Filehandle — if Append is enabled, the filehandle gets positioned to the end of the file via a call to seek before any uncompressed data is written to it. Otherwise the file pointer does not move.

When Append is specified and set to true, it appends all uncompressed data to the output data stream. So when the output is a filehandle it carries out a seek to the eof before writing any uncompressed data; if the output is a filename, it gets opened for appending; if the output is a buffer, all uncompressed data gets appended to the existing buffer ✨.

Conversely, when Append is not specified — or it's present and set to false — it operates like this: when the output is a filename, it truncates the contents of the file before writing any uncompressed data; if the output is a filehandle its position is not changed; if the output is a buffer, it gets 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 uncompresses the whole lot as a single data stream. Defaults to 0 🌈.
TrailingData => $scalar — returns the data, if any, that's present immediately after the compressed data stream once uncompression is complete. This one's for when there's 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 returns everything from the end of the compressed data stream to the end of the buffer.

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

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

And if you already know the length of the compressed data stream before you start uncompressing, you can dodge needing trailingData entirely by setting the InputLength option — main character problem-solving energy 👑.

🌟 OneShot Examples 🌟

Say you've got a zip file, file1.zip, that 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 $input = "file1.zip";
my $output = "file1.txt";
unzip $input => $output
    or die "unzip failed: $UnzipError\n";

If your zip file contains multiple members and you want to read one specific member from it — 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";

Or, if you'd rather read that data1 member straight 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

And 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, this is where it gets cute. Instead of calling functions everywhere, you get an actual object 💅 and you can treat it like a filehandle. Like, full on <$z> energy. Obsessed.

🎀 Constructor

The constructor for IO::Uncompress::Unzip looks exactly like this:

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

It takes one mandatory parameter, $input (defined below, keep scrolling 🌸), and zero or more OPTS, which are all defined down in "Constructor Options".

On success you get an IO::Uncompress::Unzip object back 🎉 and on failure you get undef. The variable $UnzipError will hold an error message when it fails — so maybe actually check it, bestie, instead of just dying mysteriously 😭.

If you're running Perl 5.005 or better, the object $z you got back from IO::Uncompress::Unzip can be used exactly like an IO::File filehandle. Which means literally all the normal input file operations work on $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 ✨

Iconic detail incoming: 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, specifically that one member, no cap.
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 💀 so like, be aware.

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. One after another, no skipping 🫶.

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's not possible to work out where the compressed data begins without having to read the first few bytes. If that's the case, the uncompression can be primed with these bytes using this option. It's giving "here's a lil head start" 💖.

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. Very precise, very main character energy ⭐.

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.

Ngl that's a whole lot of options but every single one of them is doing something real 💅

Okay so that's the constructor and its options all handled — next part is gonna keep the momentum going, don't go anywhere 🦋

💅 METHODS 💅

Okay bestie, this is the method era. The object has so many moves, and each one is lowkey iconic in its own way. Let's go method by method, no skips, no cap. ✨

💖 `read` — the block-reader one

Usage is:

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

This one reads a block of compressed data — the size of that compressed block is determined by the Buffer option you passed to the constructor — then uncompresses it and writes any uncompressed data into $buffer.

If the Append parameter is set in the constructor, the uncompressed data gets appended to $buffer. Otherwise $buffer gets overwritten, periodt.

Returns the number of uncompressed bytes written to $buffer, zero if eof, or a negative number on error. 🫶

💖 `read` — the length-specified one

Same name, different era. Usage is:

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

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

Attempts to read $length bytes of uncompressed data into $buffer.

The main difference between this form of the read method and the previous one is that this one will attempt to return exactly $length bytes. The only times it won't are if end-of-file or an IO error is encountered.

Returns the number of uncompressed bytes written to $buffer, zero if eof, or a negative number on error. 🌸

💖 `getline`

Usage is:

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

Reads a single line. Simple, iconic, does what it says.

This method fully supports the use of the variable $/ — or $INPUT_RECORD_SEPARATOR, or $RS when English is in use — to determine what counts as an end of line. Paragraph mode, record mode, and file slurp mode are all supported. 🎀

💖 `getc`

Usage is:

$char = $z->getc()

Reads a single character. Tiny but mighty. 🦋

💖 `ungetc`

Usage is:

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

That's the whole vibe for this one, bestie. 💜

💖 `inflateSync`

Usage is:

$status = $z->inflateSync()

The docs say TODO 😭. That's literally what's there, so I'm not gonna invent lore.

💖 `getHeaderInfo`

Usage is:

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

This method returns either a hash reference — in scalar context — or a list of hash references — in array context — that contains information about each of the header fields in the compressed data stream(s). Multiple streams? It's giving thorough. 👑

💖 `tell`

Usage is:

$z->tell()
tell $z

Returns the uncompressed file offset. That's it, that's the whole slay. ⭐

💖 `eof`

Usage is:

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

Returns true if the end of the compressed input stream has been reached. The end is giving end. 💅

💖 `seek`

Usage is:

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

Provides a sub-set of the seek functionality, with the restriction that it is only legal to seek forward in the input file/buffer.

🚨 It is a fatal error to attempt to seek backward. Like, do not do it. The code will not be cute about it.

Note that the implementation of seek in this module does not provide true random access to a compressed file/buffer. It works by uncompressing data from the current offset in the file/buffer until it reaches the uncompressed offset specified in the parameters to seek.

For very small files this may be acceptable behaviour. For large files it may cause an unacceptable delay. So, like, know your file size, bestie.

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 is:

$z->binmode
binmode $z ;

This is a noop provided for completeness. It's giving "I'm here so the API feels complete." 🎀

💖 `opened`

Usage is:

$z->opened()

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

💖 `autoflush`

Usage is:

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 is non-zero, it will enable flushing after every write/print operation.

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

Note that the special variable $| cannot be used to set or retrieve the autoflush setting. Not me finding that out the hard way. 😭

💖 `input_line_number`

Usage is:

$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.

Note that setting the line number does not change the current position within the file/buffer being read. So don't expect it to teleport you anywhere.

The contents of $/ are used to determine what constitutes a line terminator. 👑

💖 `fileno`

Usage is:

$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 is called, fileno will return undef.

If the $z object is associated with a buffer, this method will return undef. 🦋

💖 `close`

Usage is:

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

Closes the output file/buffer.

For most versions of Perl this method will be automatically invoked if the IO::Uncompress::Unzip object is destroyed — either explicitly or by the variable with the reference to the object going out of scope.

The exceptions are Perl versions 5.005 through 5.00504 and 5.8.0. In these cases, the close method will be called automatically, but not until global destruction of all live objects when the program is terminating.

Therefore, if you want your scripts to be able to run on all versions of Perl, you should call close explicitly and not rely on automatic closing. That's the safe-girl move. 💅

Returns true on success, otherwise 0.

If the AutoClose option has been enabled when the IO::Uncompress::Unzip object was created, and the object is associated with a file, the underlying file will also be closed. ✨

💖 `nextStream`

Usage is:

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 will be cleared and $. will be reset to 0.

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.

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

💖 `trailingData`

Usage is:

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

Returns the data, if any, that is present immediately after the compressed data stream once uncompression is complete.

It only makes sense to call this method once the end of the compressed data stream has been encountered. So don't call it early and expect main character energy from it.

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 in the constructor. 🧚

📦 IMPORTING 📦

No symbolic constants are required by IO::Uncompress::Unzip at present.

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

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

🌈 EXAMPLES 🌈

✨ Simple Read ✨

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 $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();

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 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.

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 is called. This will skip to the start of the next compressed data stream and clear the end-of-file flag.

It is also worth noting that nextStream can be called at any time — you don't have to wait until you have exhausted a compressed data stream before skipping to the next one. So go ahead, skip like the main character you are. 💅

✨ 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/bug reports should be sent to <https://github.com/pmqs/IO-Compress/issues> (preferred) or <https://rt.cpan.org/Public/Dist/Display.html?Name=IO-Compress>. 💖

🌈 SEE ALSO 🌈

Okay bestie, the compression-verse is stacked — here’s the whole squad, no cap:

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

There’s also the FAQ, which is giving “read me when you’re confused but make it cute”:

IO::Compress::FAQ

And these iconique neighbors are in the chat too:

File::GlobMapper
Archive::Zip
Archive::Tar
IO::Zlib

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".

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". Absolute legend behavior, honestly 💅

🧾 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.

And that’s the whole page, bestie 🫶 this one ships with perl v5.42.3, dated 2026-11-03, and the footer calls it IO::Unc...s::Unzip(3pm). Byeee 💖✨🎀

📦 where this page comes from

alpine 3.24: perl-doc 5.42.3-r0 · Artistic-1.0-Perl OR GPL-1.0-or-later
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on 2026-11-04: a language model's rewrite of the original, under its terms

IO::UNCOMPRESS::UNZIP(3pm)

💖 NAME 💖

✨ SYNOPSIS ✨

🦋 DESCRIPTION 🦋

🌸 Compression methods it can handle rn 🌸

✨ Functional Interface ✨

unzip $input_filename_or_reference => $output_filename_or_reference [, OPTS]

The $input_filename_or_reference parameter

The $output_filename_or_reference parameter

Notes

🎀 Optional Parameters 🎀

🌟 OneShot Examples 🌟

🦋 OO INTERFACE 🦋

🎀 Constructor

🌈 A filename

🌈 A filehandle

🌈 A scalar reference

✨ Constructor Options ✨

💅 METHODS 💅

💖 read — the block-reader one

💖 read — the length-specified one

💖 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]`

The `$input_filename_or_reference` parameter

The `$output_filename_or_reference` parameter

💖 `read` — the block-reader one

💖 `read` — the length-specified one

💖 `getline`

💖 `getc`

💖 `ungetc`

💖 `inflateSync`

💖 `getHeaderInfo`

💖 `tell`

💖 `eof`

💖 `seek`

💖 `binmode`

💖 `opened`

💖 `autoflush`

💖 `input_line_number`

💖 `fileno`

💖 `close`

💖 `nextStream`

💖 `trailingData`