内容

• 名称
• 语法
• 描述
• 功能接口
  • rawinflate $input_filename_or_reference => $output_filename_or_reference [, OPTS]
    • $input_filename_or_reference 参数
    • $output_filename_or_reference 参数
  • 注释
  • 可选参数
  • 示例
• OO 接口
  • 构造函数
  • 构造函数选项
  • 示例
• 方法
  • read
  • read
  • getline
  • getc
  • ungetc
  • inflateSync
  • getHeaderInfo
  • tell
  • eof
  • seek
  • binmode
  • opened
  • autoflush
  • input_line_number
  • fileno
  • close
  • nextStream
  • trailingData
• 导入
• 示例
  • 与 Net::FTP 配合使用
• 支持
• 另请参阅
• 作者
• 修改历史
• 版权和许可证

#名称

IO::Uncompress::RawInflate - 读取 RFC 1951 文件/缓冲区

#语法

use IO::Uncompress::RawInflate qw(rawinflate $RawInflateError) ;

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

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

$RawInflateError ;

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

#说明

此模块提供了一个 Perl 接口，允许读取符合 RFC 1951 的文件/缓冲区。

有关写入 RFC 1951 文件/缓冲区，请参阅配套模块 IO::Compress::RawDeflate。

#函数接口

提供了一个顶级函数 rawinflate，用于在缓冲区和/或文件之间执行“一次性”解压缩。有关解压缩过程的更精细控制，请参阅 “OO 接口” 部分。

use IO::Uncompress::RawInflate qw(rawinflate $RawInflateError) ;

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

函数接口需要 Perl5.005 或更高版本。

#rawinflate $input_filename_or_reference => $output_filename_or_reference [, OPTS]

rawinflate 至少需要两个参数，$input_filename_or_reference 和 $output_filename_or_reference，以及零个或多个可选参数（请参阅 “可选参数”）

#$input_filename_or_reference 参数

参数 $input_filename_or_reference 用于定义压缩数据的来源。

它可以采用以下形式之一

#文件名

如果 $input_filename_or_reference 参数是一个简单的标量，则假定它是一个文件名。此文件将被打开以供读取，并且输入数据将从中读取。

#文件句柄

如果 $input_filename_or_reference 参数是一个文件句柄，则输入数据将从中读取。字符串 '-' 可用作标准输入的别名。

#标量引用

如果 $input_filename_or_reference 是一个标量引用，则输入数据将从 $$input_filename_or_reference 读取。

#数组引用

如果 $input_filename_or_reference 是一个数组引用，则数组中的每个元素都必须是一个文件名。

输入数据将依次从每个文件中读取。

将遍历整个数组以确保它只包含有效文件名，然后才能解压缩任何数据。

#输入文件 glob 字符串

如果 $input_filename_or_reference 是一个以字符 "<" 和 ">" 分隔的字符串，则 rawinflate 将假定它是一个输入文件 glob 字符串。输入是与文件 glob 匹配的文件列表。

有关更多详细信息，请参见 File::GlobMapper。

如果 $input_filename_or_reference 参数是任何其他类型，则将返回 undef。

#$output_filename_or_reference 参数

$output_filename_or_reference 参数用于控制未压缩数据的目标位置。此参数可以采用以下形式之一。

#文件名

如果 $output_filename_or_reference 参数是一个简单的标量，则假定它是一个文件名。此文件将被打开以进行写入，并且未压缩的数据将被写入其中。

#文件句柄

如果 $output_filename_or_reference 参数是一个文件句柄，则未压缩的数据将被写入其中。字符串 '-' 可用作标准输出的别名。

#标量引用

如果 $output_filename_or_reference 是一个标量引用，则未压缩的数据将存储在 $$output_filename_or_reference 中。

#数组引用

如果 $output_filename_or_reference 是一个数组引用，则未压缩的数据将被推送到数组中。

#输出文件通配符

如果 $output_filename_or_reference 是一个由字符 "<" 和 ">" 分隔的字符串，则 rawinflate 将假定它是一个输出文件通配符字符串。输出是与文件通配符匹配的文件列表。

当 $output_filename_or_reference 是一个文件通配符字符串时，$input_filename_or_reference 也必须是一个文件通配符字符串。其他任何内容都是错误的。

有关更多详细信息，请参见 File::GlobMapper。

如果 $output_filename_or_reference 参数是任何其他类型，则将返回 undef。

#注释

当 $input_filename_or_reference 映射到多个压缩文件/缓冲区，并且 $output_filename_or_reference 是一个文件/缓冲区时，在解压缩后，$output_filename_or_reference 将包含来自每个输入文件/缓冲区的所有未压缩数据的串联。

#可选参数

一次性函数 rawinflate 的可选参数（在大多数情况下）与在 “构造函数选项” 部分中定义的 OO 接口中使用的参数相同。例外情况如下所列

#AutoClose => 0|1

此选项适用于文件句柄的任何输入或输出数据流到rawinflate。

如果指定了AutoClose并且值为真，则在rawinflate完成后，所有输入和/或输出文件句柄将关闭。

此参数默认为 0。

#BinModeOut => 0|1

此选项现在是无操作。所有文件都将以二进制模式写入。

#Append => 0|1

此选项的行为取决于输出数据流的类型。

• 缓冲区

  如果启用了Append，所有未压缩的数据都将附加到输出缓冲区的末尾。否则，在向输出缓冲区写入任何未压缩数据之前，将清除输出缓冲区。

• 文件名

  如果启用了Append，则文件将在追加模式下打开。否则，在向其中写入任何未压缩数据之前，将截断文件的内容（如果有）。

• 文件句柄

  如果启用了Append，则在向其中写入任何未压缩数据之前，将通过调用seek将文件句柄定位到文件末尾。否则，文件指针将不会移动。

当指定Append并将其设置为真时，它将把所有未压缩数据附加到输出数据流。

因此，当输出是文件句柄时，它将在写入任何未压缩数据之前执行对 eof 的搜索。如果输出是文件名，它将被打开以进行追加。如果输出是缓冲区，所有未压缩的数据都将附加到现有缓冲区。

相反，当未指定Append，或存在且设置为假时，它将按如下方式操作。

当输出是文件名时，它将在写入任何未压缩数据之前截断文件的内容。如果输出是文件句柄，则其位置不会改变。如果输出是缓冲区，它将在输出任何未压缩数据之前被擦除。

默认为 0。

#MultiStream => 0|1

此选项是无操作。

#TrailingData => $scalar

在解压缩完成后，返回压缩数据流之后立即存在的数据（如果有）。

当压缩数据流之后紧跟有用的信息，并且你不知道压缩数据流的长度时，可以使用此选项。

如果输入是缓冲区，trailingData将返回从压缩数据流末尾到缓冲区末尾的所有内容。

如果输入是一个文件句柄，trailingData 将返回压缩数据流结束之后文件句柄输入缓冲区中剩余的数据。然后，您可以使用文件句柄读取输入文件的其余部分。

如果输入是文件名，请不要使用 trailingData。

如果您在开始解压缩之前知道压缩数据流的长度，可以通过设置 InputLength 选项来避免使用 trailingData。

#示例

读取文件 file1.txt.1951 的内容并将解压缩的数据写入文件 file1.txt。

use strict ;
use warnings ;
use IO::Uncompress::RawInflate qw(rawinflate $RawInflateError) ;

my $input = "file1.txt.1951";
my $output = "file1.txt";
rawinflate $input => $output
    or die "rawinflate failed: $RawInflateError\n";

从现有的 Perl 文件句柄 $input 读取并解压缩数据到缓冲区 $buffer。

use strict ;
use warnings ;
use IO::Uncompress::RawInflate qw(rawinflate $RawInflateError) ;
use IO::File ;

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

解压缩目录 "/my/home" 中所有匹配 "*.txt.1951" 的文件并将压缩数据存储在同一目录中

use strict ;
use warnings ;
use IO::Uncompress::RawInflate qw(rawinflate $RawInflateError) ;

rawinflate '</my/home/*.txt.1951>' => '</my/home/#1.txt>'
    or die "rawinflate failed: $RawInflateError\n";

如果您希望一次压缩一个文件，这将奏效

use strict ;
use warnings ;
use IO::Uncompress::RawInflate qw(rawinflate $RawInflateError) ;

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

#面向对象接口

#构造函数

IO::Uncompress::RawInflate 的构造函数格式如下所示

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

成功时返回 IO::Uncompress::RawInflate 对象，失败时返回未定义。失败时，变量 $RawInflateError 将包含错误消息。

如果您运行的是 Perl 5.005 或更高版本，则从 IO::Uncompress::RawInflate 返回的对象 $z 可以完全像 IO::File 文件句柄一样使用。这意味着可以使用 $z 执行所有正常的输入文件操作。例如，要从压缩文件/缓冲区中读取一行，可以使用以下任何一种形式

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

强制参数 $input 用于确定压缩数据的来源。此参数可以采用三种形式之一。

#文件名

如果 $input 参数是标量，则假定它是一个文件名。此文件将被打开以供读取，并且压缩数据将从中读取。

#文件句柄

如果 $input 参数是一个文件句柄，则压缩数据将从中读取。字符串 '-' 可用作标准输入的别名。

#标量引用

如果$input是一个标量引用，压缩数据将从$$input读取。

#构造函数选项

下面定义的选项名称不区分大小写，并且可以可选地加上前缀“-”。因此，以下所有选项都是有效的

-AutoClose
-autoclose
AUTOCLOSE
autoclose

OPTS是以下选项的组合

#AutoClose => 0|1

此选项仅在$input参数为文件句柄时有效。如果指定，并且值为 true，则在调用close方法或销毁 IO::Uncompress::RawInflate 对象后，文件将被关闭。

此参数默认为 0。

#MultiStream => 0|1

允许将多个连接的压缩流视为单个压缩流。一旦达到文件/缓冲区的末尾、遇到错误（过早的 eof、损坏的压缩数据）或流的末尾没有立即跟随另一个流的开头，解压缩将停止。

此参数默认为 0。

#Prime => $string

此选项将在处理输入文件/缓冲区之前解压缩$string的内容。

当压缩数据嵌入在另一个文件/数据结构中，并且在不读取前几个字节的情况下无法确定压缩数据开始位置时，此选项非常有用。如果是这种情况，可以使用此选项使用这些字节对解压缩进行“预处理”。

#Transparent => 0|1

如果设置此选项并且输入文件/缓冲区不是压缩数据，则模块将允许读取它。

此外，如果输入文件/缓冲区确实包含压缩数据，并且紧跟其后有未压缩的数据，则设置此选项将使此模块将整个文件/缓冲区视为单个数据流。

此选项默认为 1。

#BlockSize => $num

在读取压缩输入数据时，IO::Uncompress::RawInflate 将以$num字节的块读取它。

此选项默认为 4096。

#InputLength => $size

此选项出现时，将限制从输入文件/缓冲区读取的压缩字节数为$size。当压缩数据流之后有直接有用的数据，并且你事先知道压缩数据流的确切长度时，可以使用此选项。

此选项通常在从文件句柄读取时使用，在这种情况下，文件指针将指向压缩数据流之后的第一个字节。

此选项默认为关闭。

#Append => 0|1

此选项控制 read 方法对未压缩数据执行的操作。

如果设置为 1，所有未压缩数据将附加到 read 方法的输出参数。

如果设置为 0，read 方法的输出参数的内容将被未压缩数据覆盖。

默认为 0。

#Strict => 0|1

此选项是无操作。

#示例

TODO

#方法

#read

用法为

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

读取一个压缩数据块（压缩块的大小由构造函数中的 Buffer 选项确定），解压缩它并将任何未压缩数据写入 $buffer。如果在构造函数中设置了 Append 参数，未压缩数据将附加到 $buffer 参数。否则，将覆盖 $buffer。

返回写入 $buffer 的未压缩字节数，如果 eof 或错误，则返回零或负数。

#read

用法为

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

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

尝试将 $length 字节的未压缩数据读入 $buffer。

此 read 方法形式与前一个形式之间的主要区别在于，此形式将尝试返回正好 $length 字节。此函数不执行此操作的唯一情况是遇到文件结尾或 IO 错误。

返回写入 $buffer 的未压缩字节数，如果 eof 或错误，则返回零或负数。

#getline

用法为

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

读取单行。

此方法完全支持使用变量 $/（或在使用 English 时使用 $INPUT_RECORD_SEPARATOR 或 $RS）来确定构成行尾的内容。段落模式、记录模式和文件 slurp 模式均受支持。

#getc

用法为

$char = $z->getc()

读取单个字符。

#ungetc

用法为

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

#inflateSync

用法为

$status = $z->inflateSync()

TODO

#getHeaderInfo

用法为

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

此方法返回哈希引用（在标量上下文中）或列表或哈希引用（在数组上下文中），其中包含有关压缩数据流中每个标头字段的信息。

#tell

用法为

$z->tell()
tell $z

返回未压缩文件偏移量。

#eof

用法为

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

如果已达到压缩输入流的末尾，则返回 true。

#seek

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

提供 seek 功能的子集，限制为只能在输入文件/缓冲区中向前查找。尝试向后查找是致命错误。

请注意，此模块中 seek 的实现不提供对压缩文件/缓冲区的真正随机访问。它通过从文件/缓冲区中的当前偏移量解压缩数据来工作，直到达到 seek 参数中指定的未压缩偏移量。对于非常小的文件，这可能是可接受的行为。对于大文件，这可能会导致不可接受的延迟。

$whence 参数采用通常的值，即 SEEK_SET、SEEK_CUR 或 SEEK_END。

成功时返回 1，失败时返回 0。

#binmode

用法为

$z->binmode
binmode $z ;

这是一个为完整性而提供的空操作。

#opened

$z->opened()

如果对象当前引用已打开的文件/缓冲区，则返回 true。

#autoflush

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

如果 $z 对象与文件或文件句柄相关联，则此方法将返回底层文件句柄的当前自动刷新设置。如果 EXPR 存在且非零，它将在每次写入/打印操作后启用刷新。

如果 $z 与缓冲区相关联，则此方法无效，始终返回 undef。

注意特殊变量 $| 不能用于设置或检索自动刷新设置。

#input_line_number

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

返回当前未压缩的行号。如果 EXPR 存在，则它具有设置行号的效果。请注意，设置行号不会更改正在读取的文件/缓冲区中的当前位置。

$/ 的内容用于确定行终止符是什么。

#fileno

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

如果 $z 对象与文件或文件句柄相关联，则 fileno 将返回底层文件描述符。调用 close 方法后，fileno 将返回 undef。

如果 $z 对象与缓冲区关联，此方法将返回 undef。

#close

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

关闭输出文件/缓冲区。

对于大多数版本的 Perl，如果 IO::Uncompress::RawInflate 对象被销毁（显式地或通过引用对象的变量超出范围），此方法将自动调用。例外是 Perl 版本 5.005 到 5.00504 和 5.8.0。在这些情况下，close 方法将自动调用，但直到程序终止时所有活动对象的全局销毁为止。

因此，如果您希望您的脚本能够在所有版本的 Perl 上运行，您应该显式调用 close，而不依赖于自动关闭。

成功时返回 true，否则返回 0。

如果在创建 IO::Uncompress::RawInflate 对象时已启用 AutoClose 选项，并且该对象与文件关联，则基础文件也将被关闭。

#nextStream

用法为

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

跳到输入文件/缓冲区中的下一个压缩数据流。如果找到新的压缩数据流，eof 标记将被清除，$. 将重置为 0。

如果找到新的流，则返回 1；如果未找到，则返回 0；如果遇到错误，则返回 -1。

#trailingData

用法为

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

在解压缩完成后，返回压缩数据流之后立即存在的数据（如果有）。只有在遇到压缩数据流的末尾后，调用此方法才有意义。

当压缩数据流之后紧跟有用的信息，并且你不知道压缩数据流的长度时，可以使用此选项。

如果输入是缓冲区，trailingData将返回从压缩数据流末尾到缓冲区末尾的所有内容。

如果输入是一个文件句柄，trailingData 将返回压缩数据流结束之后文件句柄输入缓冲区中剩余的数据。然后，您可以使用文件句柄读取输入文件的其余部分。

如果输入是文件名，请不要使用 trailingData。

如果您在开始解压缩之前知道压缩数据流的长度，您可以通过在构造函数中设置 InputLength 选项来避免使用 trailingData。

#Importing

目前 IO::Uncompress::RawInflate 不需要任何符号常量。

#:all

导入 rawinflate 和 $RawInflateError。与执行以下操作相同

use IO::Uncompress::RawInflate qw(rawinflate $RawInflateError) ;

#EXAMPLES

#使用 Net::FTP

参见 IO::Compress::FAQ

#支持

一般反馈/问题/错误报告应发送至 https://github.com/pmqs/IO-Compress/issues（首选）或 https://rt.cpan.org/Public/Dist/Display.html?Name=IO-Compress。

#另请参见

Compress::Zlib、IO::Compress::Gzip、IO::Uncompress::Gunzip、IO::Compress::Deflate、IO::Uncompress::Inflate、IO::Compress::RawDeflate、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

有关 RFC 1950、1951 和 1952，请参见 https://datatracker.ietf.org/doc/html/rfc1950、https://datatracker.ietf.org/doc/html/rfc1951 和 https://datatracker.ietf.org/doc/html/rfc1952

zlib 压缩库由 Jean-loup Gailly [email protected] 和 Mark Adler [email protected] 编写。

zlib 压缩库的主要网站是 http://www.zlib.org。

zlib-ng 压缩库的主要网站是 https://github.com/zlib-ng/zlib-ng。

gzip 的主要网站是 http://www.gzip.org。

#作者

此模块由 Paul Marquess 编写，[email protected]。

#修改历史

参见 Changes 文件。

#版权和许可

版权所有 (c) 2005-2023 Paul Marquess。保留所有权利。

此程序是免费软件；您可以在与 Perl 本身相同的条款下重新分发或修改它。

Perldoc 浏览器由 Dan Book (DBOOK) 维护。如有任何有关网站本身、搜索或文档呈现的问题，请通过 GitHub 问题跟踪器 或 电子邮件 联系他。

Perl 文档由 Perl 5 Porters 在 Perl 开发中维护。如有任何有关文档内容或格式的问题，请通过 Perl 问题跟踪器、邮件列表 或 IRC 联系他们。