IO::Com...Deflate(3)

πŸ“¦ version 2.220.0, in opensuse-leap 16.0

πŸ’… NAME πŸ’…

So bestie, this is from the IO::Compress::RawDeflate(3) page β€” User Contributed Perl Documentation, and it's literally called IO::Compress::RawDeflate β€” Write RFC 1951 files/buffers. That's the whole vibe: making them, not reading them. πŸŽ€


✨ SYNOPSIS ✨

    use IO::Compress::RawDeflate qw(rawdeflate $RawDeflateError) ;

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

    my $z = IO::Compress::RawDeflate->new( $output [,OPTS] )
        or die "rawdeflate failed: $RawDeflateError\n";

    $z->print($string);
    $z->printf($format, $string);
    $z->write($string);
    $z->syswrite($string [, $length, $offset]);
    $z->flush();
    $z->tell();
    $z->eof();
    $z->seek($position, $whence);
    $z->binmode();
    $z->fileno();
    $z->opened();
    $z->autoflush();
    $z->input_line_number();
    $z->newStream( [OPTS] );

    $z->deflateParams();

    $z->close() ;

    $RawDeflateError ;

    # IO::File mode

    print $z $string;
    printf $z $format, $string;
    tell $z
    eof $z
    seek $z, $position, $whence
    binmode $z
    fileno $z
    close $z ;

Like, look at all those methods. She's got range. πŸ‘‘


πŸ¦‹ DESCRIPTION πŸ¦‹

This module gives you a Perl interface that lets you write compressed data to files or buffers, exactly as defined in RFC 1951. Iconic. ✨

⚠️ Real talk though: RFC 1951 data is not a good choice of compression format to use in isolation, especially if you want to auto-detect it. So don't come crying to me when nothing recognizes your file, bestie. 😭

Wanna go the other direction? If you're reading RFC 1951 files/buffers, that's the companion module IO::Uncompress::RawInflate. Different page, different girl. 🫢

🌈 Functional Interface

There's a top-level function, rawdeflate, that does "one-shot" compression between buffers and/or files. If you want finer control over the compression process, scroll on down to the "OO Interface" section. πŸ’–

    use IO::Compress::RawDeflate qw(rawdeflate $RawDeflateError) ;

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

Heads up: the functional interface needs Perl5.005 or better. Old tech, but she still slays. πŸ’€

πŸ’œ rawdeflate $input_filename_or_reference => $output_filename_or_reference [, OPTS]

rawdeflate expects at least two parameters β€” $input_filename_or_reference and $output_filename_or_reference β€” plus zero or more optional parameters (see "Optional Parameters" below, or just keep reading, it's right there).

🌸 The $input_filename_or_reference parameter

The parameter $input_filename_or_reference defines where the uncompressed data comes from. 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. This file gets opened for reading, and the input data is read from it.

A filehandle If $input_filename_or_reference is a filehandle, the input data gets 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 gets 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 gets read from each file in turn. The complete array will be walked to make sure it only contains valid filenames before any data is compressed β€” so it checks first, no cap. 🧚

An Input FileGlob string If $input_filename_or_reference is a string delimited by the characters < and >, rawdeflate will assume it's 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. That's it. That's the whole response. πŸ™ˆ

πŸŽ€ The $output_filename_or_reference parameter

The parameter $output_filename_or_reference controls the destination of the compressed 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. This file gets opened for writing, and the compressed data gets written to it.

A filehandle If $output_filename_or_reference is a filehandle, the compressed 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 compressed data gets stored in $$output_filename_or_reference.

An Array Reference If $output_filename_or_reference is an array reference, the compressed data gets pushed onto the array.

An Output FileGlob If $output_filename_or_reference is a string delimited by the characters < and >, rawdeflate will assume it's 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. Periodt. πŸ’…

See File::GlobMapper for more details.

⭐ If the $output_filename_or_reference parameter is any other type, undef will be returned. Same energy as before.

πŸ”₯ Notes

When $input_filename_or_reference maps to multiple files/buffers and $output_filename_or_reference is a single file/buffer, the input files/buffers get stored in $output_filename_or_reference as a concatenated series of compressed data streams. It's giving "all my friends in one group chat." πŸ’–

🌈 Optional Parameters

The optional parameters for the one-shot function rawdeflate are (for the most part) identical to those used with the OO interface defined in the "Constructor Options" section. The exceptions are listed below β€” so these are the special ones, the exceptions, the main characters. πŸ‘‘

  • "AutoClose => 0|1" β€” This one applies to any input or output data streams given to rawdeflate that are filehandles. If "AutoClose" is specified and the value is true, it results in all input and/or output filehandles being closed once rawdeflate has completed. Defaults to 0.
  • "BinModeIn => 0|1" β€” This option is now a no-op. All files will be read in binmode. She's retired, but she's still on the list. πŸ’€
  • "Append => 0|1" β€” The behaviour of this option depends on the type of output data stream:
    • A Buffer β€” If "Append" is enabled, all compressed data gets appended to the end of the output buffer. Otherwise the output buffer gets cleared before any compressed 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 compressed 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 compressed data is written to it. Otherwise the file pointer will not be moved.

When "Append" is specified and set to true, it appends all compressed 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 compressed data. If the output is a filename, it will be opened for appending. If the output is a buffer, all compressed data gets appended to the existing buffer. πŸ’…

Conversely, when "Append" is not specified, or it's present and set to false, it operates as follows:

When the output is a filename, it truncates the contents of the file before writing any compressed data. If the output is a filehandle, its position will not be changed. If the output is a buffer, it gets wiped before any compressed data is output. Bye bye, data. 😭

Defaults to 0.

πŸŽ€ Oneshot Examples

Here are a few examples showing what the module can do. Capabilities! Demonstrated! Slay! ✨

πŸ’œ Streaming

This very simple command line example demonstrates the streaming capabilities of the module. The code reads data from STDIN, compresses it, and writes the compressed data to STDOUT.

    $ echo hello world | perl -MIO::Compress::RawDeflate=rawdeflate -e 'rawdeflate \*STDIN => \*STDOUT' >output.1951

The special filename "-" can be used as a standin for both "\*STDIN" and "\*STDOUT", so the above can be rewritten as

    $ echo hello world | perl -MIO::Compress::RawDeflate=rawdeflate -e 'rawdeflate "-" => "-"' >output.1951

Look at her go. 🌈

πŸ¦‹ Compressing a file from the filesystem

To read the contents of the file "file1.txt" and write the compressed data to the file "file1.txt.1951":

    use strict ;
    use warnings ;
    use IO::Compress::RawDeflate qw(rawdeflate $RawDeflateError) ;

    my $input = "file1.txt";
    rawdeflate $input => "$input.1951"
        or die "rawdeflate failed: $RawDeflateError\n";

🌸 Reading from a Filehandle and writing to an in-memory buffer

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

    use strict ;
    use warnings ;
    use IO::Compress::RawDeflate qw(rawdeflate $RawDeflateError) ;
    use IO::File ;

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

πŸ’– Compressing multiple files

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

    use strict ;
    use warnings ;
    use IO::Compress::RawDeflate qw(rawdeflate $RawDeflateError) ;

    rawdeflate '</my/home/*.txt>' => '<*.1951>'
        or die "rawdeflate failed: $RawDeflateError\n";

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

    use strict ;
    use warnings ;
    use IO::Compress::RawDeflate qw(rawdeflate $RawDeflateError) ;

    for my $input ( glob "/my/home/*.txt" )
    {
        my $output = "$input.1951" ;
        rawdeflate $input => $output
            or die "Error compressing '$input': $RawDeflateError\n";
    }

Glob and slay, bestie. ✨ (lowkey more incoming β€” don't go anywhere πŸ’œ)

✨ OO Interface ✨


πŸ› οΈ Constructor

Okay bestie, here’s the constructor format for IO::Compress::RawDeflate β€” it’s giving very β€œmake your object, or perish” energy:

my $z = IO::Compress::RawDeflate->new( $output [,OPTS] )
    or die "IO::Compress::RawDeflate failed: $RawDeflateError\n";

The constructor takes one mandatory parameter, $output β€” defined below β€” and zero or more OPTS, which are defined in Constructor Options.

It returns an IO::Compress::RawDeflate object on success and undef on failure. The variable $RawDeflateError will contain an error message on failure. So like… always check, bestie. 😭

If you are running Perl 5.005 or better, the object $z returned from IO::Compress::RawDeflate can be used exactly like an IO::File filehandle. That means all normal output file operations can be carried out with $z. For example, to write to a compressed file/buffer you can use either of these forms:

$z->print("hello world\n");
print $z "hello world\n";

Below is a simple example of using the OO interface to create an output file myfile.1951 and write some data to it:

my $filename = "myfile.1951";
my $z = IO::Compress::RawDeflate->new($filename)
    or die "IO::Compress::RawDeflate failed: $RawDeflateError\n";

$z->print("abcde");
$z->close();

See the Examples for more. πŸ’–

The mandatory parameter $output is used to control the destination of the compressed data. This parameter can take one of these forms.

πŸ“ A filename

If the $output parameter is a simple scalar, it is assumed to be a filename. This file will be opened for writing and the compressed data will be written to it.

πŸ–¨οΈ A filehandle

If the $output parameter is a filehandle, the compressed data will be written to it. The string - can be used as an alias for standard output.

🧺 A scalar reference

If $output is a scalar reference, the compressed data will be stored in $$output.

If the $output parameter is any other type, "IO::Compress::RawDeflate"::new will return undef.


πŸŽ›οΈ Constructor Options

OPTS is any combination of zero or more of the following options:

  • AutoClose => 0|1 β€” This option is only valid when the $output parameter is a filehandle. If specified, and the value is true, it will result in the $output being closed once either the close method is called or the IO::Compress::RawDeflate object is destroyed. This parameter defaults to 0.
  • Append => 0|1 β€” Opens $output in append mode. The behaviour of this option is dependent on the type of $output.
    • A Buffer β€” If $output is a buffer and Append is enabled, all compressed data will be appended to the end of $output. Otherwise $output will be cleared before any data is written to it.
    • A Filename β€” If $output is a filename and Append is enabled, the file will be opened in append mode. Otherwise the contents of the file, if any, will be truncated before any compressed data is written to it.
    • A Filehandle β€” If $output is a filehandle, the file pointer will be positioned to the end of the file via a call to seek before any compressed data is written to it. Otherwise the file pointer will not be moved.

This parameter defaults to 0.

  • Merge => 0|1 β€” This option is used to compress input data and append it to an existing compressed data stream in $output. The end result is a single compressed data stream stored in $output.
🚨 It is a fatal error to attempt to use this option when $output is not an RFC 1951 data stream.

There are a number of other limitations with the Merge option:

  1. This module needs to have been built with zlib 1.2.1 or better to work. A fatal error will be thrown if Merge is used with an older version of zlib.
  2. If $output is a file or a filehandle, it must be seekable.

This parameter defaults to 0.

  • -Level β€” Defines the compression level used by zlib. The value should either be a number between 0 and 9 (0 means no compression and 9 is maximum compression), or one of the symbolic constants defined below:
Z_NO_COMPRESSION
Z_BEST_SPEED
Z_BEST_COMPRESSION
Z_DEFAULT_COMPRESSION

The default is Z_DEFAULT_COMPRESSION.

Note, these constants are not imported by IO::Compress::RawDeflate by default.

use IO::Compress::RawDeflate qw(:strategy);
use IO::Compress::RawDeflate qw(:constants);
use IO::Compress::RawDeflate qw(:all);
  • -Strategy β€” Defines the strategy used to tune the compression. Use one of the symbolic constants defined below:
Z_FILTERED
Z_HUFFMAN_ONLY
Z_RLE
Z_FIXED
Z_DEFAULT_STRATEGY

The default is Z_DEFAULT_STRATEGY.

  • Strict => 0|1 β€” This is a placeholder option. Yup, it’s just sitting there looking cute. πŸŽ€

🌟 Examples

πŸ“‘ Streaming

This very simple command line example demonstrates the streaming capabilities of the module. The code reads data from STDIN or all the files given on the commandline, compresses it, and writes the compressed data to STDOUT.

use strict ;
use warnings ;
use IO::Compress::RawDeflate qw(rawdeflate $RawDeflateError) ;

my $z = IO::Compress::RawDeflate->new("-", Stream => 1)
    or die "IO::Compress::RawDeflate failed: $RawDeflateError\n";

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

Note the use of - to mean STDOUT. Alternatively you can use \*STDOUT.

πŸ“‚ Compressing a file from the filesystem

To read the contents of the file file1.txt and write the compressed data to the file file1.txt.1951 there are a few options.

Start by creating the compression object and opening the input file:

use strict ;
use warnings ;
use IO::Compress::RawDeflate qw(rawdeflate $RawDeflateError) ;

my $input = "file1.txt";
my $z = IO::Compress::RawDeflate->new("file1.txt.1951")
    or die "IO::Compress::RawDeflate failed: $RawDeflateError\n";

# open the input file
open my $fh, "<", "file1.txt"
    or die "Cannot open file1.txt: $!\n";

# loop through the input file & write to the compressed file
while (<$fh>) {
    $z->print($_);
}

# not forgetting to close the compressed file
$z->close();

πŸ’… Methods πŸ’…

Okay bestie, this is the part where we actually do stuff with the $z object. All the moves, all the slays. Let's go 🫢

🌸 print

Usage is

$z->print($data)
print $z $data

Compresses and outputs the contents of the $data parameter. Lowkey it has the same behaviour as the print built-in.

Returns true if successful. ✨

🌸 printf

Usage is

$z->printf($format, $data)
printf $z $format, $data

Compresses and outputs the contents of the $data parameter.

Returns true if successful.

🌸 syswrite

Usage is

$z->syswrite $data
$z->syswrite $data, $length
$z->syswrite $data, $length, $offset

Compresses and outputs the contents of the $data parameter.

Returns the number of uncompressed bytes written, or undef if unsuccessful. That's uncompressed bytes, bestie β€” don't get it twisted 😭

🌸 write

Usage is

$z->write $data
$z->write $data, $length
$z->write $data, $length, $offset

Compresses and outputs the contents of the $data parameter.

Returns the number of uncompressed bytes written, or undef if unsuccessful.

🌸 flush

Usage is

$z->flush;
$z->flush($flush_type);

Flushes any pending compressed data to the output file/buffer. Get that data out of there, periodt πŸ’…

This method takes an optional parameter, $flush_type, that controls how the flushing will be carried out. By default the $flush_type used is Z_FINISH. Other valid values for $flush_type are Z_NO_FLUSH, Z_SYNC_FLUSH, Z_FULL_FLUSH and Z_BLOCK.

Okay so real talk 🚨 It is strongly recommended that you only set the flush_type parameter if you fully understand the implications of what it does β€” overuse of flush can seriously degrade the level of compression achieved. See the zlib documentation for details. Don't just be out here flushing for the vibes, ngl.

Returns true on success.

🌸 tell

Usage is

$z->tell()
tell $z

Returns the uncompressed file offset.

🌸 eof

Usage is

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

Returns true if the close method has been called. That's it. That's the whole vibe check πŸ‘‘

🌸 seek

$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 output file/buffer. It is a fatal error to attempt to seek backward. So like, no time travel. We only move forward here ✨

Empty parts of the file/buffer will have NULL (0x00) bytes written to them.

The $whence parameter takes one 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. Literally does nothing, it's just there so your code looks complete. Iconic honestly πŸ’€

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

Heads up bestie πŸ™ˆ Note that the special variable $| cannot be used to set or retrieve the autoflush setting. Different system, different girlies.

🌸 input_line_number

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

This method always returns undef when compressing. We're not reading, we're writing β€” stay in your lane πŸŽ€

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

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

🌸 close

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

Flushes any pending compressed data and then closes the output file/buffer. The big finale πŸ¦‹

For most versions of Perl this method will be automatically invoked if the IO::Compress::RawDeflate 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. No cap, just call it yourself. Be the main character, take responsibility πŸ’ͺ

Returns true on success, otherwise 0.

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

🌸 newStream([OPTS])

Usage is

$z->newStream( [OPTS] )

Closes the current compressed data stream and starts a new one. Out with the old, in with the new, we love a fresh start 🌈

OPTS consists of any of the options that are available when creating the $z object.

See the Constructor Options section for more details.

🌸 deflateParams

Usage is

$z->deflateParams

TODO

That's it. That's the documentation. TODO. Absolutely iconique of the author, we respect the honesty πŸ˜­πŸ’€


✨ Importing ✨

A number of symbolic constants are required by some methods in IO::Compress::RawDeflate. None are imported by default. So if something's missing, that's why β€” it's not you, it's the defaults 🫢

  • :all β€” Imports rawdeflate, $RawDeflateError and all symbolic constants that can be used by IO::Compress::RawDeflate. Same as doing this
use IO::Compress::RawDeflate qw(rawdeflate $RawDeflateError :constants) ;
  • :constants β€” Import all symbolic constants. Same as doing this
use IO::Compress::RawDeflate qw(:flush :level :strategy) ;
  • :flush β€” These symbolic constants are used by the flush method.
Z_NO_FLUSH
Z_PARTIAL_FLUSH
Z_SYNC_FLUSH
Z_FULL_FLUSH
Z_FINISH
Z_BLOCK
  • :level β€” These symbolic constants are used by the Level option in the constructor.
Z_NO_COMPRESSION
Z_BEST_SPEED
Z_BEST_COMPRESSION
Z_DEFAULT_COMPRESSION
  • :strategy β€” These symbolic constants are used by the Strategy option in the constructor.
Z_FILTERED
Z_HUFFMAN_ONLY
Z_RLE
Z_FIXED
Z_DEFAULT_STRATEGY

πŸŽ€ EXAMPLES πŸŽ€

πŸ’œ Apache::GZip Revisited

See IO::Compress::FAQ. It's giving "I'll tell you later" but honestly the FAQ is that girl πŸ’…

πŸ’œ Working with Net::FTP

See IO::Compress::FAQ. Same FAQ, same energy. Go read it bestie, I promise it eats πŸ“


πŸ¦‹ 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>.

Got thoughts? Got bugs? Got a glow-up idea? Send it. The GitHub link is the preferred one, so maybe start there πŸ‘‘


⭐ SEE ALSO ⭐

Compress::Zlib, IO::Compress::Gzip, IO::Uncompress::Gunzip, IO::Compress::Deflate, IO::Uncompress::Inflate, 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. Shoutout to the founders, fr fr πŸ™Œ

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. King behaviour πŸ‘‘πŸ’–


🌸 MODIFICATION HISTORY 🌸

See the Changes file. (It's giving "the receipts are in the group chat" πŸ“±)


Copyright (c) 2005-2026 Paul Marquess. All rights reserved.

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


And that's a wrap on the whole page, bestie!! πŸŽ€βœ¨ This masterpiece of a manpage is from perl v5.42.0, dated 2026-05-17 β€” go forth and compress responsibly, mwah πŸ’œπŸ¦‹

πŸ“¦ where this page comes from