IO::Unc...:Gunzip(3pm)

📦

version 5.42.3 · 17 versions

💖 IO::Uncompress::Gunzip — reading RFC 1952 files/buffers ✨

Bestie. Sit down. This is IO::Uncompress::Gunzip, a page from the Perl Programmers Reference Guide, and it's literally your new fave for reading .gz-style stuff. It's the IO::Uncompress::Gunzip manpage, and today we're getting you fully caught up. 🫶

It's a Perl module that gives you an interface for reading files/buffers that conform to RFC 1952. That's the vibe. 🦋

💅 And if you're trying to write RFC 1952 files/buffers instead? That's her sister, the companion module IO::Compress::Gzip. Different girl. Go see her.

🌸 SYNOPSIS

Like, the whole thing up front, no cap:

use IO::Uncompress::Gunzip qw(gunzip $GunzipError) ;

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

my $z = IO::Uncompress::Gunzip->new( $input [OPTS] )
    or die "gunzip failed: $GunzipError\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()

$GunzipError ;

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

Yes queen, that's a lot. Breathe. We'll go through it. 💜

✨ DESCRIPTION ✨

Okay so, this module gives you a Perl interface that lets you read files/buffers conforming to RFC 1952. That's the entire assignment and she ate. 🔥

For writing RFC 1952 files/buffers? That's the companion module IO::Compress::Gzip — go knock on her door. 🎀

🧚 Functional Interface

There's a top-level function called "gunzip" that handles "one-shot" uncompression between buffers and/or files. Like, one call, done, main character energy. 👑

But if you want finer control over the whole uncompression process, you're gonna want the "OO Interface" section instead — that's the deluxe version. ⭐

use IO::Uncompress::Gunzip qw(gunzip $GunzipError) ;

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

🫶 Heads up bestie: the functional interface needs Perl5.005 or better. Periodt.

🌈 `gunzip $input_filename_or_reference => $output_filename_or_reference [, OPTS]`

"gunzip" expects at least two parameters — $input_filename_or_reference and $output_filename_or_reference — plus zero or more optional parameters. Those optionals are in the "Optional Parameters" section, we'll get there. 😌

🍓 The `$input_filename_or_reference` parameter

This parameter defines the source of the compressed data. 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 is read from it. And fun fact, 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 is 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 is read from each file in turn. And before anything gets uncompressed, the complete array is walked to make sure it only contains valid filenames. Safety first, icon behaviour. ✨
An Input FileGlob string — if $input_filename_or_reference is a string delimited by the characters "<" and ">", "gunzip" assumes it's an input fileglob string. The input is the list of files that match the fileglob. See File::GlobMapper for more details. 🦋

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

🎀 The `$output_filename_or_reference` parameter

This one controls the destination of the uncompressed data. It can take one of these forms:

A filename — if $output_filename_or_reference is a simple scalar, it's assumed to be a filename. It gets opened for writing and the uncompressed data gets written to it. 📝
A filehandle — if $output_filename_or_reference is a filehandle, the uncompressed data gets written to it. And 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 is stored in $$output_filename_or_reference.
An Array Reference — if $output_filename_or_reference is an array reference, the uncompressed data is pushed onto the array.
An Output FileGlob — if $output_filename_or_reference is a string delimited by the characters "<" and ">", "gunzip" assumes it's an output fileglob string. The output is the list of files that match the fileglob.

😭 Important: 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 mixing and matching, bestie. See File::GlobMapper for more details. 🌟

💀 And if $output_filename_or_reference is any other type, "undef" will be returned. Same energy as the input side.

📝 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. Like a group chat merging into one very long message. 💬✨

🌸 Optional Parameters

The optional parameters for the one-shot "gunzip" function are (for the most part) identical to those used with the OO interface defined in the "Constructor Options" section. The exceptions are listed below — don't skip them, they're the plot twists. 🙈

"AutoClose => 0|1" — this option applies to any input or output data streams to "gunzip" that are filehandles. If "AutoClose" is specified and the value is true, it results in all input and/or output filehandles being closed once "gunzip" has completed. Defaults to 0. 🔒
"BinModeOut => 0|1" — this option is now a no-op. All files will be written in binmode. She's retired, but she's still on the guest list. 💅
"Append => 0|1" — the behaviour of this option depends on the type of output data stream:
- A Buffer — if "Append" is enabled, all uncompressed data will be appended 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 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 won't be 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 option can be used when there's 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" 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 that's 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. Genuinely, save yourself.

And if you already know the length of the compressed data stream before you start uncompressing, you can avoid having to use "trailingData" by setting the "InputLength" option. Big brain move, honestly. 🧠✨

👑 OneShot Examples

🍓 Example the first

To read the contents of the file "file1.txt.gz" and write the uncompressed data to the file "file1.txt":

use strict ;
use warnings ;
use IO::Uncompress::Gunzip qw(gunzip $GunzipError) ;

my $input = "file1.txt.gz";
my $output = "file1.txt";
gunzip $input => $output
    or die "gunzip failed: $GunzipError\n";

🦋 Example the second

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

use strict ;
use warnings ;
use IO::Uncompress::Gunzip qw(gunzip $GunzipError) ;
use IO::File ;

my $input = IO::File->new( "<file1.txt.gz" )
    or die "Cannot open 'file1.txt.gz': $!\n" ;
my $buffer ;
gunzip $input => \$buffer
    or die "gunzip failed: $GunzipError\n";

🌈 Example the third

To uncompress all files in the directory "/my/home" that match "*.txt.gz" and store the compressed data in the same directory:

use strict ;
use warnings ;
use IO::Uncompress::Gunzip qw(gunzip $GunzipError) ;

gunzip '</my/home/*.txt.gz>' => '</my/home/#1.txt>'
    or die "gunzip failed: $GunzipError\n";

🎀 Example the fourth

And if you want to compress each file one at a time, this will do the trick:

use strict ;
use warnings ;
use IO::Uncompress::Gunzip qw(gunzip $GunzipError) ;

for my $input ( glob "/my/home/*.txt.gz" )
{
    my $output = $input;
    $output =~ s/.gz// ;
    gunzip $input => $output
        or die "Error compressing '$input': $GunzipError\n";
}

✨ and that's where part 1 wraps — more coming, bestie, don't go anywhere 💖

💅 OO INTERFACE 💅

Okay bestie, this is the object-oriented era of the page. The constructor format for IO::Uncompress::Gunzip is literally this:

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

The constructor takes one mandatory parameter, $input, defined below, and zero or more OPTS, defined in Constructor Options.

It returns an IO::Uncompress::Gunzip object on success and undef on failure. The variable $GunzipError will contain an error message on failure.

If you are running Perl 5.005 or better the object, $z, returned from IO::Uncompress::Gunzip can be used exactly like an IO::File filehandle. That means 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.gz and write its contents to stdout.

my $filename = "myfile.gz";
my $z = IO::Uncompress::Gunzip->new($filename)
    or die "IO::Uncompress::Gunzip failed: $GunzipError\n";

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

See the EXAMPLES section 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:

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::Gunzip object is destroyed. This parameter defaults to 0.
MultiStream => 0|1 — Allows multiple concatenated compressed streams to be treated as a single compressed stream. Decompression will stop once either the end of the file/buffer is reached, an error is encountered (premature eof, corrupt compressed data) or the end of a stream is not immediately followed by the start of another stream. 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. Yes bestie, default is ON — remember that.
BlockSize => $num — When reading the compressed input data, IO::Uncompress::Gunzip 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.
1. If the FHCRC bit is set in the gzip FLG header byte, the CRC16 bytes in the header must match the crc16 value of the gzip header actually read.
2. If the gzip header contains a name field (FNAME) it consists solely of ISO 8859-1 characters.
3. If the gzip header contains a comment field (FCOMMENT) it consists solely of ISO 8859-1 characters plus line-feed.
4. If the gzip FEXTRA header field is present it must conform to the sub-field structure as defined in RFC 1952.
5. The CRC32 and ISIZE trailer fields must be present.
6. The value of the CRC32 field read must match the crc32 value of the uncompressed data actually contained in the gzip file.
7. The value of the ISIZE fields read must match the length of the uncompressed data actually read from the file.
ParseExtra => 0|1 — If the gzip FEXTRA header field is present and this option is set, it will force the module to check that it conforms to the sub-field structure as defined in RFC 1952. If Strict is on it will automatically enable this option. Defaults to 0.

🌸 METHODS 🌸

Okay bestie, this is the good part — all the methods you can call on your $z object. Buckle up 💖

🦋 read 🦋

The vibe check version. Usage is

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

So what it does is: it reads a block of compressed data — and yeah, the size of that compressed block is decided by the Buffer option you passed to the constructor, not by you right now — then it uncompresses it and writes all the uncompressed data into $buffer. Now, if you set the Append parameter in the constructor, the uncompressed data gets appended to $buffer (nothing gets thrown away 🫶). Otherwise $buffer gets straight-up overwritten. No cap.

Returns the number of uncompressed bytes written to $buffer, zero if eof, or a negative number on error. Negative = something went wrong, go check 😭

🫶 read (yes, again — the `$length` one) 🫶

Same name, different job, iconic honestly. Usage is

$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 $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 circumstances where it won't are if end-of-file happens or an IO error is encountered. That's it, that's the whole list 💅

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. That's the whole pitch, bestie.

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. All of them. Slay 🌈

🍓 getc 🍓

Usage is

$char = $z->getc()

Read a single character. One. Singular. Tiny little guy 🥺

🧚 ungetc 🧚

Usage is

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

(That's the whole entry in the original too — no extra deets given, so I'm not inventing any, bestie. 🙈)

💀 inflateSync 💀

Usage is

$status = $z->inflateSync()

TODO

Yeah. That's genuinely what the docs say. Not me being lazy — the manpage itself just says TODO and leaves it there 💀

👑 getHeaderInfo 👑

Usage is

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

This method returns either a hash reference (if you call it in scalar context) or a list of hash references (if you call it in array context), and that thing contains info about each of the header fields in the compressed data stream(s). Multi-stream? Multi-header. We love a list 🫶

Here's what's in there:

Name — The contents of the Name header field, if present. If no name is present, the value will be undef. Note this is different from a zero length name, which will return an empty string. Yes, undef and "" are different things, they're not the same vibe at all, don't @ me.
Comment — The contents of the Comment header field, if present. If no comment is present, the value will be undef. Note this is different from a zero length comment, which will return an empty string. Same energy as above 💜

⭐ tell ⭐

Usage is

$z->tell()
tell $z

Returns the uncompressed file offset. So like, where you are in the uncompressed world, not the compressed one. Iykyk.

🌸 eof 🌸

Usage is

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

Returns true if the end of the compressed input stream has been reached. The end bestie. We're done. 🦋

💅 seek 💅

Usage:

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

This gives you a sub-set of the seek functionality, and the restriction is a big one: it is only legal to seek forward in the input file/buffer. Attempting to seek backward is a fatal error. Like, the program dies. Not playing around 😭

Also, lowkey important: the implementation of seek in this module does not provide true random access to a compressed file/buffer. What it actually does is uncompress data from the current offset in the file/buffer until it reaches the uncompressed offset you specified in the parameters to seek. For very small files this may be acceptable behaviour. For large files it may cause an unacceptable delay 😬

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 does nothing. It's here so your code doesn't explode. Respect the noop 🫶

🦋 opened 🦋

$z->opened()

Returns true if the object currently refers to a 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 will enable flushing after every write/print operation. Flush it, bestie, don't let it sit there 💖

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

Note that the special variable $| cannot be used to set or retrieve the autoflush setting here. I know, I know. Don't try it. It won't work. 🙈

🔥 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. Note that setting the line number does not change the current position within the file/buffer being read. Line count and position are two separate girlies, they don't talk.

The contents of $/ are used to determine what constitutes 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 is called, fileno will return undef. It's gone. Bye.

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

💜 close 💜

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

Closes the output file/buffer.

Now listen, because this part actually matters 👑 For most versions of Perl this method will be automatically invoked if the IO::Uncompress::Gunzip object is destroyed (either explicitly, or by the variable holding the reference to the object going out of scope). The exceptions are Perl versions 5.005 through 5.00504 and 5.8.0. In those cases, the close method will be called automatically — but not until global destruction of all live objects when the program is terminating. Which is late. Real late. 💀

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. Be the main character, close your own files. ✨

Returns true on success, otherwise 0.

If the AutoClose option has been enabled when the IO::Uncompress::Gunzip object was created, and the object is associated with a file, the underlying file will also be closed. Two-for-one 🤝

🌟 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. Fresh start, clean slate, new era 💅

Returns 1 if a new stream was found, 0 if none was found, and -1 if an error was encountered. Three outcomes, three numbers, memorize them iykyk.

🎀 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. (Call it early and you're just guessing, bestie.)

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. Very "surprise bonus content" of it 🌸

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. Obsessed with the handoff. 🫶

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

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. Pre-planning is highkey underrated ✨

🎁 IMPORTING 🎁

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

:all — Imports gunzip and $GunzipError. Same as doing this

use IO::Uncompress::Gunzip qw(gunzip $GunzipError) ;

🌈 EXAMPLES 🌈

🐟 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 👀

A whole squad, okay, here we go:

Compress::Zlib, IO::Compress::Gzip, 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

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". Legend behaviour 👑

📜 MODIFICATION HISTORY 📜

See the Changes file.

💖 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 — you made it to the end 🎀 This cutie was stamped for perl v5.42.3 on 2026-11-03, and it's the IO::Uncompress::Gunzip(3pm) page being iconic as always. Go uncompress something. 💅✨

📦 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::Unc...:Gunzip(3pm)

💖 IO::Uncompress::Gunzip — reading RFC 1952 files/buffers ✨

🌸 SYNOPSIS

✨ DESCRIPTION ✨

🧚 Functional Interface

🌈 gunzip $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

🍓 Example the first

🦋 Example the second

🌈 Example the third

🎀 Example the fourth

💅 OO INTERFACE 💅

📁 A filename

🫶 A filehandle

🎀 A scalar reference

✨ Constructor Options ✨

🌸 METHODS 🌸

🦋 read 🦋

🫶 read (yes, again — the $length one) 🫶

🎀 getline 🎀

🍓 getc 🍓

🧚 ungetc 🧚

💀 inflateSync 💀

👑 getHeaderInfo 👑

⭐ tell ⭐

🌸 eof 🌸

💅 seek 💅

🎀 binmode 🎀

🦋 opened 🦋

🌈 autoflush 🌈

🔥 input_line_number 🔥

🧚 fileno 🧚

💜 close 💜

🌟 nextStream 🌟

🎀 trailingData 🎀

🎁 IMPORTING 🎁

🌈 EXAMPLES 🌈

🐟 Working with Net::FTP 🐟

💌 SUPPORT 💌

👀 SEE ALSO 👀

✍️ AUTHOR ✍️

📜 MODIFICATION HISTORY 📜

💖 COPYRIGHT AND LICENSE 💖

🌈 `gunzip $input_filename_or_reference => $output_filename_or_reference [, OPTS]`

🍓 The `$input_filename_or_reference` parameter

🎀 The `$output_filename_or_reference` parameter

🫶 read (yes, again — the `$length` one) 🫶