{ "content": [ { "type": "text", "text": "# IO::Uncompress::AnyUncompress (info)\n\n## NAME\n\nIO::Uncompress::AnyUncompress - Uncompress gzip, zip, bzip2, zstd, xz, lzma, lzip, lzf or lzop file/buffer\n\n## SYNOPSIS\n\nuse IO::Uncompress::AnyUncompress qw(anyuncompress $AnyUncompressError) ;\nmy $status = anyuncompress $input => $output [,OPTS]\nor die \"anyuncompress failed: $AnyUncompressError\\n\";\nmy $z = IO::Uncompress::AnyUncompress->new( $input [OPTS] )\nor die \"anyuncompress failed: $AnyUncompressError\\n\";\n$status = $z->read($buffer)\n$status = $z->read($buffer, $length)\n$status = $z->read($buffer, $length, $offset)\n$line = $z->getline()\n$char = $z->getc()\n$char = $z->ungetc()\n$char = $z->opened()\n$data = $z->trailingData()\n$status = $z->nextStream()\n$data = $z->getHeaderInfo()\n$z->tell()\n$z->seek($position, $whence)\n$z->binmode()\n$z->fileno()\n$z->eof()\n$z->close()\n$AnyUncompressError ;\n# IO::File mode\n<$z>\nread($z, $buffer);\nread($z, $buffer, $length);\nread($z, $buffer, $length, $offset);\ntell($z)\nseek($z, $position, $whence)\nbinmode($z)\nfileno($z)\neof($z)\nclose($z)\n\n## DESCRIPTION\n\nThis module provides a Perl interface that allows the reading of\nfiles/buffers that have been compressed with a variety of compression\nlibraries.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **Functional Interface**\n- **Methods**\n- **Importing**\n- **EXAMPLES**\n- **SUPPORT**\n- **SEE ALSO**\n- **AUTHOR**\n- **MODIFICATION HISTORY**\n- **COPYRIGHT AND LICENSE**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "IO::Uncompress::AnyUncompress", "section": "", "mode": "info", "summary": "IO::Uncompress::AnyUncompress - Uncompress gzip, zip, bzip2, zstd, xz, lzma, lzip, lzf or lzop file/buffer", "synopsis": "use IO::Uncompress::AnyUncompress qw(anyuncompress $AnyUncompressError) ;\nmy $status = anyuncompress $input => $output [,OPTS]\nor die \"anyuncompress failed: $AnyUncompressError\\n\";\nmy $z = IO::Uncompress::AnyUncompress->new( $input [OPTS] )\nor die \"anyuncompress failed: $AnyUncompressError\\n\";\n$status = $z->read($buffer)\n$status = $z->read($buffer, $length)\n$status = $z->read($buffer, $length, $offset)\n$line = $z->getline()\n$char = $z->getc()\n$char = $z->ungetc()\n$char = $z->opened()\n$data = $z->trailingData()\n$status = $z->nextStream()\n$data = $z->getHeaderInfo()\n$z->tell()\n$z->seek($position, $whence)\n$z->binmode()\n$z->fileno()\n$z->eof()\n$z->close()\n$AnyUncompressError ;\n# IO::File mode\n<$z>\nread($z, $buffer);\nread($z, $buffer, $length);\nread($z, $buffer, $length, $offset);\ntell($z)\nseek($z, $position, $whence)\nbinmode($z)\nfileno($z)\neof($z)\nclose($z)", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [], "examples": [], "see_also": [], "section_outline": [ { "name": "NAME", "lines": 3, "subsections": [] }, { "name": "SYNOPSIS", "lines": 41, "subsections": [] }, { "name": "DESCRIPTION", "lines": 21, "subsections": [] }, { "name": "Functional Interface", "lines": 399, "subsections": [] }, { "name": "Methods", "lines": 221, "subsections": [] }, { "name": "Importing", "lines": 8, "subsections": [] }, { "name": "EXAMPLES", "lines": 1, "subsections": [] }, { "name": "SUPPORT", "lines": 4, "subsections": [] }, { "name": "SEE ALSO", "lines": 13, "subsections": [] }, { "name": "AUTHOR", "lines": 2, "subsections": [] }, { "name": "MODIFICATION HISTORY", "lines": 2, "subsections": [] }, { "name": "COPYRIGHT AND LICENSE", "lines": 6, "subsections": [] } ], "sections": { "NAME": { "content": "IO::Uncompress::AnyUncompress - Uncompress gzip, zip, bzip2, zstd, xz,\nlzma, lzip, lzf or lzop file/buffer\n", "subsections": [] }, "SYNOPSIS": { "content": "use IO::Uncompress::AnyUncompress qw(anyuncompress $AnyUncompressError) ;\n\nmy $status = anyuncompress $input => $output [,OPTS]\nor die \"anyuncompress failed: $AnyUncompressError\\n\";\n\nmy $z = IO::Uncompress::AnyUncompress->new( $input [OPTS] )\nor die \"anyuncompress failed: $AnyUncompressError\\n\";\n\n$status = $z->read($buffer)\n$status = $z->read($buffer, $length)\n$status = $z->read($buffer, $length, $offset)\n$line = $z->getline()\n$char = $z->getc()\n$char = $z->ungetc()\n$char = $z->opened()\n\n$data = $z->trailingData()\n$status = $z->nextStream()\n$data = $z->getHeaderInfo()\n$z->tell()\n$z->seek($position, $whence)\n$z->binmode()\n$z->fileno()\n$z->eof()\n$z->close()\n\n$AnyUncompressError ;\n\n# IO::File mode\n\n<$z>\nread($z, $buffer);\nread($z, $buffer, $length);\nread($z, $buffer, $length, $offset);\ntell($z)\nseek($z, $position, $whence)\nbinmode($z)\nfileno($z)\neof($z)\nclose($z)\n", "subsections": [] }, "DESCRIPTION": { "content": "This module provides a Perl interface that allows the reading of\nfiles/buffers that have been compressed with a variety of compression\nlibraries.\n\nThe formats supported are:\n\nRFC 1950\nRFC 1951 (optionally)\ngzip (RFC 1952)\nzip\nzstd (Zstandard)\nbzip2\nlzop\nlzf\nlzma\nlzip\nxz\n\nThe module will auto-detect which, if any, of the supported compression\nformats is being used.\n", "subsections": [] }, "Functional Interface": { "content": "A top-level function, \"anyuncompress\", is provided to carry out \"one-\nshot\" uncompression between buffers and/or files. For finer control\nover the uncompression process, see the \"OO Interface\" section.\n\nuse IO::Uncompress::AnyUncompress qw(anyuncompress $AnyUncompressError) ;\n\nanyuncompress $inputfilenameorreference => $outputfilenameorreference [,OPTS]\nor die \"anyuncompress failed: $AnyUncompressError\\n\";\n\nThe functional interface needs Perl5.005 or better.\n\nanyuncompress $inputfilenameorreference => $outputfilenameorreference\n[, OPTS]\n\"anyuncompress\" expects at least two parameters,\n$inputfilenameorreference and $outputfilenameorreference and zero\nor more optional parameters (see \"Optional Parameters\")\n\nThe $inputfilenameorreference parameter\n\nThe parameter, $inputfilenameorreference, is used to define the\nsource of the compressed data.\n\nIt can take one of the following forms:\n\nA filename\nIf the $inputfilenameorreference parameter is a simple scalar,\nit is assumed to be a filename. This file will be opened for\nreading and the input data will be read from it.\n\nA filehandle\nIf the $inputfilenameorreference parameter is a filehandle, the\ninput data will be read from it. The string '-' can be used as an\nalias for standard input.\n\nA scalar reference\nIf $inputfilenameorreference is a scalar reference, the input\ndata will be read from $$inputfilenameorreference.\n\nAn array reference\nIf $inputfilenameorreference is an array reference, each\nelement in the array must be a filename.\n\nThe input data will be read from each file in turn.\n\nThe complete array will be walked to ensure that it only contains\nvalid filenames before any data is uncompressed.\n\nAn Input FileGlob string\nIf $inputfilenameorreference is a string that is delimited by\nthe characters \"<\" and \">\" \"anyuncompress\" will assume that it is\nan input fileglob string. The input is the list of files that\nmatch the fileglob.\n\nSee File::GlobMapper for more details.\n\nIf the $inputfilenameorreference parameter is any other type,\n\"undef\" will be returned.\n\nThe $outputfilenameorreference parameter\n\nThe parameter $outputfilenameorreference is used to control the\ndestination of the uncompressed data. This parameter can take one of\nthese forms.\n\nA filename\nIf the $outputfilenameorreference parameter is a simple scalar,\nit is assumed to be a filename. This file will be opened for\nwriting and the uncompressed data will be written to it.\n\nA filehandle\nIf the $outputfilenameorreference parameter is a filehandle,\nthe uncompressed data will be written to it. The string '-' can\nbe used as an alias for standard output.\n\nA scalar reference\nIf $outputfilenameorreference is a scalar reference, the\nuncompressed data will be stored in\n$$outputfilenameorreference.\n\nAn Array Reference\nIf $outputfilenameorreference is an array reference, the\nuncompressed data will be pushed onto the array.\n\nAn Output FileGlob\nIf $outputfilenameorreference is a string that is delimited by\nthe characters \"<\" and \">\" \"anyuncompress\" will assume that it is\nan output fileglob string. The output is the list of files that\nmatch the fileglob.\n\nWhen $outputfilenameorreference is an fileglob string,\n$inputfilenameorreference must also be a fileglob string.\nAnything else is an error.\n\nSee File::GlobMapper for more details.\n\nIf the $outputfilenameorreference parameter is any other type,\n\"undef\" will be returned.\n\nNotes\nWhen $inputfilenameorreference maps to multiple compressed\nfiles/buffers and $outputfilenameorreference is a single\nfile/buffer, after uncompression $outputfilenameorreference will\ncontain a concatenation of all the uncompressed data from each of the\ninput files/buffers.\n\nOptional Parameters\nThe optional parameters for the one-shot function \"anyuncompress\" are\n(for the most part) identical to those used with the OO interface\ndefined in the \"Constructor Options\" section. The exceptions are listed\nbelow\n\n\"AutoClose => 0|1\"\nThis option applies to any input or output data streams to\n\"anyuncompress\" that are filehandles.\n\nIf \"AutoClose\" is specified, and the value is true, it will result\nin all input and/or output filehandles being closed once\n\"anyuncompress\" has completed.\n\nThis parameter defaults to 0.\n\n\"BinModeOut => 0|1\"\nThis option is now a no-op. All files will be written in binmode.\n\n\"Append => 0|1\"\nThe behaviour of this option is dependent on the type of output\ndata stream.\n\no A Buffer\n\nIf \"Append\" is enabled, all uncompressed data will be append\nto the end of the output buffer. Otherwise the output buffer\nwill be cleared before any uncompressed data is written to\nit.\n\no A Filename\n\nIf \"Append\" is enabled, the file will be opened in append\nmode. Otherwise the contents of the file, if any, will be\ntruncated before any uncompressed data is written to it.\n\no A Filehandle\n\nIf \"Append\" is enabled, the filehandle will be positioned to\nthe end of the file via a call to \"seek\" before any\nuncompressed data is written to it. Otherwise the file\npointer will not be moved.\n\nWhen \"Append\" is specified, and set to true, it will append all\nuncompressed data to the output data stream.\n\nSo when the output is a filehandle it will carry out a seek to the\neof before writing any uncompressed data. If the output is a\nfilename, it will be opened for appending. If the output is a\nbuffer, all uncompressed data will be appended to the existing\nbuffer.\n\nConversely when \"Append\" is not specified, or it is present and is\nset to false, it will operate as follows.\n\nWhen the output is a filename, it will truncate the contents of\nthe file before writing any uncompressed data. If the output is a\nfilehandle its position will not be changed. If the output is a\nbuffer, it will be wiped before any uncompressed data is output.\n\nDefaults to 0.\n\n\"MultiStream => 0|1\"\nIf the input file/buffer contains multiple compressed data\nstreams, this option will uncompress the whole lot as a single\ndata stream.\n\nDefaults to 0.\n\n\"TrailingData => $scalar\"\nReturns the data, if any, that is present immediately after the\ncompressed data stream once uncompression is complete.\n\nThis option can be used when there is useful information\nimmediately following the compressed data stream, and you don't\nknow the length of the compressed data stream.\n\nIf the input is a buffer, \"trailingData\" will return everything\nfrom the end of the compressed data stream to the end of the\nbuffer.\n\nIf the input is a filehandle, \"trailingData\" will return the data\nthat is left in the filehandle input buffer once the end of the\ncompressed data stream has been reached. You can then use the\nfilehandle to read the rest of the input file.\n\nDon't bother using \"trailingData\" if the input is a filename.\n\nIf you know the length of the compressed data stream before you\nstart uncompressing, you can avoid having to use \"trailingData\" by\nsetting the \"InputLength\" option.\n\nExamples\nTo read the contents of the file \"file1.txt.Compressed\" and write the\nuncompressed data to the file \"file1.txt\".\n\nuse strict ;\nuse warnings ;\nuse IO::Uncompress::AnyUncompress qw(anyuncompress $AnyUncompressError) ;\n\nmy $input = \"file1.txt.Compressed\";\nmy $output = \"file1.txt\";\nanyuncompress $input => $output\nor die \"anyuncompress failed: $AnyUncompressError\\n\";\n\nTo read from an existing Perl filehandle, $input, and write the\nuncompressed data to a buffer, $buffer.\n\nuse strict ;\nuse warnings ;\nuse IO::Uncompress::AnyUncompress qw(anyuncompress $AnyUncompressError) ;\nuse IO::File ;\n\nmy $input = IO::File->new( \" \\$buffer\nor die \"anyuncompress failed: $AnyUncompressError\\n\";\n\nTo uncompress all files in the directory \"/my/home\" that match\n\"*.txt.Compressed\" and store the compressed data in the same directory\n\nuse strict ;\nuse warnings ;\nuse IO::Uncompress::AnyUncompress qw(anyuncompress $AnyUncompressError) ;\n\nanyuncompress '' => ''\nor die \"anyuncompress failed: $AnyUncompressError\\n\";\n\nand if you want to compress each file one at a time, this will do the\ntrick\n\nuse strict ;\nuse warnings ;\nuse IO::Uncompress::AnyUncompress qw(anyuncompress $AnyUncompressError) ;\n\nfor my $input ( glob \"/my/home/*.txt.Compressed\" )\n{\nmy $output = $input;\n$output =~ s/.Compressed// ;\nanyuncompress $input => $output\nor die \"Error compressing '$input': $AnyUncompressError\\n\";\n}\n\nOO Interface\nConstructor\nThe format of the constructor for IO::Uncompress::AnyUncompress is\nshown below\n\nmy $z = IO::Uncompress::AnyUncompress->new( $input [OPTS] )\nor die \"IO::Uncompress::AnyUncompress failed: $AnyUncompressError\\n\";\n\nReturns an \"IO::Uncompress::AnyUncompress\" object on success and undef\non failure. The variable $AnyUncompressError will contain an error\nmessage on failure.\n\nIf you are running Perl 5.005 or better the object, $z, returned from\nIO::Uncompress::AnyUncompress can be used exactly like an IO::File\nfilehandle. This means that all normal input file operations can be\ncarried out with $z. For example, to read a line from a compressed\nfile/buffer you can use either of these forms\n\n$line = $z->getline();\n$line = <$z>;\n\nThe mandatory parameter $input is used to determine the source of the\ncompressed data. This parameter can take one of three forms.\n\nA filename\nIf the $input parameter is a scalar, it is assumed to be a\nfilename. This file will be opened for reading and the compressed\ndata will be read from it.\n\nA filehandle\nIf the $input parameter is a filehandle, the compressed data will\nbe read from it. The string '-' can be used as an alias for\nstandard input.\n\nA scalar reference\nIf $input is a scalar reference, the compressed data will be read\nfrom $$input.\n\nConstructor Options\nThe option names defined below are case insensitive and can be\noptionally prefixed by a '-'. So all of the following are valid\n\n-AutoClose\n-autoclose\nAUTOCLOSE\nautoclose\n\nOPTS is a combination of the following options:\n\n\"AutoClose => 0|1\"\nThis option is only valid when the $input parameter is a\nfilehandle. If specified, and the value is true, it will result in\nthe file being closed once either the \"close\" method is called or\nthe IO::Uncompress::AnyUncompress object is destroyed.\n\nThis parameter defaults to 0.\n\n\"MultiStream => 0|1\"\nAllows multiple concatenated compressed streams to be treated as a\nsingle compressed stream. Decompression will stop once either the\nend of the file/buffer is reached, an error is encountered\n(premature eof, corrupt compressed data) or the end of a stream is\nnot immediately followed by the start of another stream.\n\nThis parameter defaults to 0.\n\n\"Prime => $string\"\nThis option will uncompress the contents of $string before\nprocessing the input file/buffer.\n\nThis option can be useful when the compressed data is embedded in\nanother file/data structure and it is not possible to work out\nwhere the compressed data begins without having to read the first\nfew bytes. If this is the case, the uncompression can be primed\nwith these bytes using this option.\n\n\"Transparent => 0|1\"\nIf this option is set and the input file/buffer is not compressed\ndata, the module will allow reading of it anyway.\n\nIn addition, if the input file/buffer does contain compressed data\nand there is non-compressed data immediately following it, setting\nthis option will make this module treat the whole file/buffer as a\nsingle data stream.\n\nThis option defaults to 1.\n\n\"BlockSize => $num\"\nWhen reading the compressed input data,\nIO::Uncompress::AnyUncompress will read it in blocks of $num\nbytes.\n\nThis option defaults to 4096.\n\n\"InputLength => $size\"\nWhen present this option will limit the number of compressed bytes\nread from the input file/buffer to $size. This option can be used\nin the situation where there is useful data directly after the\ncompressed data stream and you know beforehand the exact length of\nthe compressed data stream.\n\nThis option is mostly used when reading from a filehandle, in\nwhich case the file pointer will be left pointing to the first\nbyte directly after the compressed data stream.\n\nThis option defaults to off.\n\n\"Append => 0|1\"\nThis option controls what the \"read\" method does with uncompressed\ndata.\n\nIf set to 1, all uncompressed data will be appended to the output\nparameter of the \"read\" method.\n\nIf set to 0, the contents of the output parameter of the \"read\"\nmethod will be overwritten by the uncompressed data.\n\nDefaults to 0.\n\n\"Strict => 0|1\"\nThis option controls whether the extra checks defined below are\nused when carrying out the decompression. When Strict is on, the\nextra tests are carried out, when Strict is off they are not.\n\nThe default for this option is off.\n\n\"RawInflate => 0|1\"\nWhen auto-detecting the compressed format, try to test for raw-\ndeflate (RFC 1951) content using the \"IO::Uncompress::RawInflate\"\nmodule.\n\nThe reason this is not default behaviour is because RFC 1951\ncontent can only be detected by attempting to uncompress it. This\nprocess is error prone and can result is false positives.\n\nDefaults to 0.\n\n\"UnLzma => 0|1\"\nWhen auto-detecting the compressed format, try to test for\nlzmaalone content using the \"IO::Uncompress::UnLzma\" module.\n\nThe reason this is not default behaviour is because lzmaalone\ncontent can only be detected by attempting to uncompress it. This\nprocess is error prone and can result is false positives.\n\nDefaults to 0.\n\nExamples\nTODO\n", "subsections": [] }, "Methods": { "content": "read\nUsage is\n\n$status = $z->read($buffer)\n\nReads a block of compressed data (the size of the compressed block is\ndetermined by the \"Buffer\" option in the constructor), uncompresses it\nand writes any uncompressed data into $buffer. If the \"Append\"\nparameter is set in the constructor, the uncompressed data will be\nappended to the $buffer parameter. Otherwise $buffer will be\noverwritten.\n\nReturns the number of uncompressed bytes written to $buffer, zero if\neof or a negative number on error.\n\nread\nUsage is\n\n$status = $z->read($buffer, $length)\n$status = $z->read($buffer, $length, $offset)\n\n$status = read($z, $buffer, $length)\n$status = read($z, $buffer, $length, $offset)\n\nAttempt to read $length bytes of uncompressed data into $buffer.\n\nThe main difference between this form of the \"read\" method and the\nprevious one, is that this one will attempt to return exactly $length\nbytes. The only circumstances that this function will not is if end-of-\nfile or an IO error is encountered.\n\nReturns the number of uncompressed bytes written to $buffer, zero if\neof or a negative number on error.\n\ngetline\nUsage is\n\n$line = $z->getline()\n$line = <$z>\n\nReads a single line.\n\nThis method fully supports the use of the variable $/ (or\n$INPUTRECORDSEPARATOR or $RS when \"English\" is in use) to determine\nwhat constitutes an end of line. Paragraph mode, record mode and file\nslurp mode are all supported.\n\ngetc\nUsage is\n\n$char = $z->getc()\n\nRead a single character.\n\nungetc\nUsage is\n\n$char = $z->ungetc($string)\n\ngetHeaderInfo\nUsage is\n\n$hdr = $z->getHeaderInfo();\n@hdrs = $z->getHeaderInfo();\n\nThis method returns either a hash reference (in scalar context) or a\nlist or hash references (in array context) that contains information\nabout each of the header fields in the compressed data stream(s).\n\ntell\nUsage is\n\n$z->tell()\ntell $z\n\nReturns the uncompressed file offset.\n\neof\nUsage is\n\n$z->eof();\neof($z);\n\nReturns true if the end of the compressed input stream has been\nreached.\n\nseek\n$z->seek($position, $whence);\nseek($z, $position, $whence);\n\nProvides a sub-set of the \"seek\" functionality, with the restriction\nthat it is only legal to seek forward in the input file/buffer. It is\na fatal error to attempt to seek backward.\n\nNote that the implementation of \"seek\" in this module does not provide\ntrue random access to a compressed file/buffer. It works by\nuncompressing data from the current offset in the file/buffer until it\nreaches the uncompressed offset specified in the parameters to \"seek\".\nFor very small files this may be acceptable behaviour. For large files\nit may cause an unacceptable delay.\n\nThe $whence parameter takes one the usual values, namely SEEKSET,\nSEEKCUR or SEEKEND.\n\nReturns 1 on success, 0 on failure.\n\nbinmode\nUsage is\n\n$z->binmode\nbinmode $z ;\n\nThis is a noop provided for completeness.\n\nopened\n$z->opened()\n\nReturns true if the object currently refers to a opened file/buffer.\n\nautoflush\nmy $prev = $z->autoflush()\nmy $prev = $z->autoflush(EXPR)\n\nIf the $z object is associated with a file or a filehandle, this method\nreturns the current autoflush setting for the underlying filehandle. If\n\"EXPR\" is present, and is non-zero, it will enable flushing after every\nwrite/print operation.\n\nIf $z is associated with a buffer, this method has no effect and always\nreturns \"undef\".\n\nNote that the special variable $| cannot be used to set or retrieve the\nautoflush setting.\n\ninputlinenumber\n$z->inputlinenumber()\n$z->inputlinenumber(EXPR)\n\nReturns the current uncompressed line number. If \"EXPR\" is present it\nhas the effect of setting the line number. Note that setting the line\nnumber does not change the current position within the file/buffer\nbeing read.\n\nThe contents of $/ are used to determine what constitutes a line\nterminator.\n\nfileno\n$z->fileno()\nfileno($z)\n\nIf the $z object is associated with a file or a filehandle, \"fileno\"\nwill return the underlying file descriptor. Once the \"close\" method is\ncalled \"fileno\" will return \"undef\".\n\nIf the $z object is associated with a buffer, this method will return\n\"undef\".\n\nclose\n$z->close() ;\nclose $z ;\n\nCloses the output file/buffer.\n\nFor most versions of Perl this method will be automatically invoked if\nthe IO::Uncompress::AnyUncompress object is destroyed (either\nexplicitly or by the variable with the reference to the object going\nout of scope). The exceptions are Perl versions 5.005 through 5.00504\nand 5.8.0. In these cases, the \"close\" method will be called\nautomatically, but not until global destruction of all live objects\nwhen the program is terminating.\n\nTherefore, if you want your scripts to be able to run on all versions\nof Perl, you should call \"close\" explicitly and not rely on automatic\nclosing.\n\nReturns true on success, otherwise 0.\n\nIf the \"AutoClose\" option has been enabled when the\nIO::Uncompress::AnyUncompress object was created, and the object is\nassociated with a file, the underlying file will also be closed.\n\nnextStream\nUsage is\n\nmy $status = $z->nextStream();\n\nSkips to the next compressed data stream in the input file/buffer. If a\nnew compressed data stream is found, the eof marker will be cleared and\n$. will be reset to 0.\n\nReturns 1 if a new stream was found, 0 if none was found, and -1 if an\nerror was encountered.\n\ntrailingData\nUsage is\n\nmy $data = $z->trailingData();\n\nReturns the data, if any, that is present immediately after the\ncompressed data stream once uncompression is complete. It only makes\nsense to call this method once the end of the compressed data stream\nhas been encountered.\n\nThis option can be used when there is useful information immediately\nfollowing the compressed data stream, and you don't know the length of\nthe compressed data stream.\n\nIf the input is a buffer, \"trailingData\" will return everything from\nthe end of the compressed data stream to the end of the buffer.\n\nIf the input is a filehandle, \"trailingData\" will return the data that\nis left in the filehandle input buffer once the end of the compressed\ndata stream has been reached. You can then use the filehandle to read\nthe rest of the input file.\n\nDon't bother using \"trailingData\" if the input is a filename.\n\nIf you know the length of the compressed data stream before you start\nuncompressing, you can avoid having to use \"trailingData\" by setting\nthe \"InputLength\" option in the constructor.\n", "subsections": [] }, "Importing": { "content": "No symbolic constants are required by IO::Uncompress::AnyUncompress at\npresent.\n\n:all Imports \"anyuncompress\" and $AnyUncompressError. Same as doing\nthis\n\nuse IO::Uncompress::AnyUncompress qw(anyuncompress $AnyUncompressError) ;\n", "subsections": [] }, "EXAMPLES": { "content": "", "subsections": [] }, "SUPPORT": { "content": "General feedback/questions/bug reports should be sent to\n (preferred) or\n.\n", "subsections": [] }, "SEE ALSO": { "content": "Compress::Zlib, IO::Compress::Gzip, IO::Uncompress::Gunzip,\nIO::Compress::Deflate, IO::Uncompress::Inflate,\nIO::Compress::RawDeflate, IO::Uncompress::RawInflate,\nIO::Compress::Bzip2, IO::Uncompress::Bunzip2, IO::Compress::Lzma,\nIO::Uncompress::UnLzma, IO::Compress::Xz, IO::Uncompress::UnXz,\nIO::Compress::Lzip, IO::Uncompress::UnLzip, IO::Compress::Lzop,\nIO::Uncompress::UnLzop, IO::Compress::Lzf, IO::Uncompress::UnLzf,\nIO::Compress::Zstd, IO::Uncompress::UnZstd, IO::Uncompress::AnyInflate\n\nIO::Compress::FAQ\n\nFile::GlobMapper, Archive::Zip, Archive::Tar, IO::Zlib\n", "subsections": [] }, "AUTHOR": { "content": "This module was written by Paul Marquess, \"pmqs@cpan.org\".\n", "subsections": [] }, "MODIFICATION HISTORY": { "content": "See the Changes file.\n", "subsections": [] }, "COPYRIGHT AND LICENSE": { "content": "Copyright (c) 2005-2021 Paul Marquess. All rights reserved.\n\nThis program is free software; you can redistribute it and/or modify it\nunder the same terms as Perl itself.\n\nperl v5.34.0 2026-06-IO::Uncompress::AnyUncompress(3perl)", "subsections": [] } } } }