內容

• 名稱
• 語法
• 說明
• 函式介面
  • inflate $input_filename_or_reference => $output_filename_or_reference [, OPTS]
    • $input_filename_or_reference 參數
    • $output_filename_or_reference 參數
  • 註解
  • 選用參數
  • 範例
• 物件導向介面
  • 建構函式
  • 建構函式選項
  • 範例
• 方法
  • read
  • read
  • getline
  • getc
  • ungetc
  • inflateSync
  • getHeaderInfo
  • tell
  • eof
  • seek
  • binmode
  • opened
  • autoflush
  • input_line_number
  • fileno
  • close
  • nextStream
  • trailingData
• 匯入
• 範例
  • 使用 Net::FTP
• 支援
• 另請參閱
• 作者
• 修改紀錄
• 版權與授權

#名稱

IO::Uncompress::Inflate - 讀取 RFC 1950 檔案/緩衝區

#語法

use IO::Uncompress::Inflate qw(inflate $InflateError) ;

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

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

$InflateError ;

# 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 1950 的檔案/緩衝區。

有關撰寫 RFC 1950 檔案/緩衝區，請參閱附屬模組 IO::Compress::Deflate。

#功能介面

提供頂層函式 `inflate` 來執行緩衝區和/或檔案之間的「一次性」解壓縮。若要更精確地控制解壓縮程序，請參閱 「OO 介面」 區段。

use IO::Uncompress::Inflate qw(inflate $InflateError) ;

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

功能介面需要 Perl5.005 或更新版本。

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

inflate 至少需要兩個參數，$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 是陣列參考，則陣列中的每個元素都必須是檔案名稱。

會依序從每個檔案中讀取輸入資料。

會遍歷整個陣列，以確保它只包含有效的檔案名稱，然後才會解壓縮任何資料。

#輸入 FileGlob 字串

如果 $input_filename_or_reference 是以字元「<」和「>」為分隔符號的字串，則 inflate 會假設它是一個 輸入 FileGlob 字串。輸入是與 FileGlob 相符的檔案清單。

請參閱 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 是陣列參考，未壓縮資料將推送到陣列中。

#一個輸出檔案 FileGlob

如果 $output_filename_or_reference 是由字元「<」和「>」分隔的字串，inflate 會假設它是 輸出檔案 FileGlob 字串。輸出是與 FileGlob 匹配的檔案清單。

當 $output_filename_or_reference 是 FileGlob 字串時，$input_filename_or_reference 也必須是 FileGlob 字串。其他任何情況都是錯誤。

請參閱 File::GlobMapper 以取得更多詳細資訊。

如果 $output_filename_or_reference 參數是任何其他類型，將傳回 undef。

#注意事項

當 $input_filename_or_reference 映射到多個壓縮檔案/緩衝區，而 $output_filename_or_reference 是單一檔案/緩衝區時，解壓縮後 $output_filename_or_reference 將包含來自每個輸入檔案/緩衝區的所有未壓縮資料的串接。

#選用參數

一次性函式 inflate 的選用參數（在大部分情況下）與 「建構函式選項」 區段中定義的 OO 介面所使用的參數相同。例外如下列出：

#AutoClose => 0|1

此選項適用於任何輸入或輸出資料串流到 inflate 的檔案句柄。

如果指定 AutoClose，且值為 true，將導致所有輸入和/或輸出檔案句柄在 inflate 完成後關閉。

此參數預設為 0。

#BinModeOut => 0|1

此選項現在是無操作。所有檔案都將以二進位模式寫入。

#Append => 0|1

此選項的行為取決於輸出資料串流的類型。

• 緩衝區

  如果啟用 Append，所有未壓縮的資料將附加到輸出緩衝區的尾端。否則，在將任何未壓縮的資料寫入輸出緩衝區之前，會先清除輸出緩衝區。

• 檔案名稱

  如果啟用 Append，檔案將以附加模式開啟。否則，在將任何未壓縮的資料寫入檔案之前，會先將檔案的內容（如果有）截斷。

• 檔案控制代碼

  如果啟用 Append，在將任何未壓縮的資料寫入檔案之前，會透過呼叫 seek 將檔案控制代碼定位到檔案尾端。否則，檔案指標不會移動。

當指定 Append 並設定為 true 時，它會將所有未壓縮的資料附加到輸出資料串流。

因此，當輸出為檔案控制代碼時，它會在寫入任何未壓縮的資料之前執行 seek 到 eof。如果輸出為檔案名稱，它將開啟檔案以進行附加。如果輸出為緩衝區，所有未壓縮的資料將附加到現有的緩衝區。

相反地，當未指定 Append，或它存在且設定為 false 時，它將執行下列操作。

當輸出為檔案名稱時，它會在寫入任何未壓縮的資料之前截斷檔案的內容。如果輸出為檔案控制代碼，其位置不會變更。如果輸出為緩衝區，它會在輸出任何未壓縮的資料之前清除緩衝區。

預設為 0。

#MultiStream => 0|1

如果輸入檔案/緩衝區包含多個壓縮資料串流，此選項會將所有資料串流解壓縮為單一資料串流。

預設為 0。

#TrailingData => $scalar

解壓縮完成後，傳回壓縮資料串流後立即存在的資料（如果有）。

當壓縮資料串流後緊接著有有用的資訊，且您不知道壓縮資料串流的長度時，可以使用此選項。

如果輸入是緩衝區，trailingData 會傳回壓縮資料串流結束到緩衝區結束的所有內容。

如果輸入是檔案控制代碼，trailingData 會傳回壓縮資料串流結束後，檔案控制代碼輸入緩衝區中剩下的資料。然後，您可以使用檔案控制代碼讀取輸入檔案的其餘部分。

如果輸入是檔案名稱，請不要使用 trailingData。

如果您在開始解壓縮前知道壓縮資料串流的長度，您可以透過設定 InputLength 選項來避免使用 trailingData。

#範例

讀取檔案 file1.txt.1950 的內容，並將解壓縮的資料寫入檔案 file1.txt。

use strict ;
use warnings ;
use IO::Uncompress::Inflate qw(inflate $InflateError) ;

my $input = "file1.txt.1950";
my $output = "file1.txt";
inflate $input => $output
    or die "inflate failed: $InflateError\n";

從現有的 Perl 檔案控制代碼 $input 讀取，並將解壓縮的資料寫入緩衝區 $buffer。

use strict ;
use warnings ;
use IO::Uncompress::Inflate qw(inflate $InflateError) ;
use IO::File ;

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

解壓縮目錄 "/my/home" 中所有符合 "*.txt.1950" 的檔案，並將壓縮資料儲存在同一個目錄中

use strict ;
use warnings ;
use IO::Uncompress::Inflate qw(inflate $InflateError) ;

inflate '</my/home/*.txt.1950>' => '</my/home/#1.txt>'
    or die "inflate failed: $InflateError\n";

如果您想要一次解壓縮一個檔案，這個方法可以達成

use strict ;
use warnings ;
use IO::Uncompress::Inflate qw(inflate $InflateError) ;

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

#OO 介面

#建構函式

IO::Uncompress::Inflate 的建構函式格式如下所示

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

如果成功，會傳回 IO::Uncompress::Inflate 物件，如果失敗，會傳回 undef。如果失敗，變數 $InflateError 會包含錯誤訊息。

如果您執行的是 Perl 5.005 或更新版本，從 IO::Uncompress::Inflate 傳回的物件 $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::Inflate 物件後關閉。

此參數預設為 0。

#MultiStream => 0|1

允許將多個串接壓縮串流視為單一壓縮串流。一旦檔案/緩衝區的結尾已達、遇到錯誤（過早的檔案結尾、損毀的壓縮資料）或串流結尾未緊接另一個串流的開頭，解壓縮就會停止。

此參數預設為 0。

#Prime => $string

此選項會在處理輸入檔案/緩衝區之前，解壓縮 $string 的內容。

當壓縮資料嵌入在另一個檔案/資料結構中，且無法在讀取前幾個位元組之前找出壓縮資料的開頭時，此選項會很有用。如果是這種情況，可以使用此選項，以這些位元組為「引子」進行解壓縮。

#Transparent => 0|1

如果設定此選項，且輸入檔案/緩衝區並非壓縮資料，模組仍會允許讀取。

此外，如果輸入檔案/緩衝區確實包含壓縮資料，且緊接在後的是未壓縮資料，設定此選項會讓此模組將整個檔案/緩衝區視為單一資料串流。

此選項預設為 1。

#BlockSize => $num

讀取壓縮輸入資料時，IO::Uncompress::Inflate 會以 $num 位元組為區塊進行讀取。

此選項預設為 4096。

#InputLength => $size

如果存在此選項，將會限制從輸入檔案/緩衝區讀取的壓縮位元組數量為 $size。此選項可用於壓縮資料串流後方有有用資料，且您事先知道壓縮資料串流的確切長度的狀況。

此選項大多用於從檔案控制碼讀取時，此時檔案指標會停留在壓縮資料串流後方的第一個位元組。

此選項預設為關閉。

#Append => 0|1

此選項控制 read 方法對未壓縮資料執行的動作。

如果設為 1，所有未壓縮資料都將附加到 read 方法的輸出參數。

如果設為 0，read 方法的輸出參數內容將被未壓縮資料覆寫。

預設為 0。

#Strict => 0|1

此選項控制執行解壓縮時是否使用以下定義的額外檢查。當 Strict 開啟時，會執行額外測試；當 Strict 關閉時，則不會執行。

此選項的預設值為關閉。

1. 必須存在 ADLER32 校驗總和欄位。

2. 讀取的 ADLER32 欄位值必須與檔案中實際包含的未壓縮資料的 adler32 值相符。

#範例

待辦事項

#方法

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

待辦事項

#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::Inflate 物件遭到銷毀（透過明確方式或參照物件的變數超出範圍），則此方法會自動呼叫。例外為 Perl 版本 5.005 至 5.00504，以及 5.8.0。在這些情況下，close 方法會自動呼叫，但直到程式終止時所有現存物件的整體銷毀為止。

因此，如果您希望您的腳本可以在所有版本的 Perl 上執行，您應該明確呼叫 close，而不是依賴自動關閉。

成功時傳回 true，否則傳回 0。

如果在建立 IO::Uncompress::Inflate 物件時已啟用 AutoClose 選項，且物件與檔案相關聯，則也會關閉底層檔案。

#nextStream

用法為

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

跳至輸入檔案/緩衝區中的下一個壓縮資料串流。如果找到新的壓縮資料串流，則會清除 eof 標記，且 $. 會重設為 0。

如果找到新的串流，則傳回 1；如果找不到，則傳回 0；如果遇到錯誤，則傳回 -1。

#trailingData

用法為

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

在解壓縮完成後，傳回壓縮資料串流後立即出現的資料（如果有）。只有在遇到壓縮資料串流的結尾時，呼叫此方法才有意義。

當壓縮資料串流後緊接著有有用的資訊，且您不知道壓縮資料串流的長度時，可以使用此選項。

如果輸入是緩衝區，trailingData 會傳回壓縮資料串流結束到緩衝區結束的所有內容。

如果輸入是檔案控制代碼，trailingData 會傳回壓縮資料串流結束後，檔案控制代碼輸入緩衝區中剩下的資料。然後，您可以使用檔案控制代碼讀取輸入檔案的其餘部分。

如果輸入是檔案名稱，請不要使用 trailingData。

如果您在開始解壓縮之前知道壓縮資料串流的長度，則可以透過在建構函式中設定 InputLength 選項，來避免使用 trailingData。

#Importing

目前 IO::Uncompress::Inflate 不需要任何符號常數。

#:all

匯入 inflate 和 $InflateError。與執行下列動作相同

use IO::Uncompress::Inflate qw(inflate $InflateError) ;

#EXAMPLES

#與 Net::FTP 搭配使用

請參閱 IO::Compress::FAQ

#SUPPORT

一般回饋/問題/錯誤報告應傳送至 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::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

有關 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 gzip@prep.ai.mit.edu 和 Mark Adler madler@alumni.caltech.edu 編寫的。

zlib 壓縮函式庫的主要網站是 http://www.zlib.org。

zlib-ng 壓縮函式庫的主要網站是 https://github.com/zlib-ng/zlib-ng。

gzip 的主要網站為 http://www.gzip.org。

#作者

此模組由 Paul Marquess 撰寫，pmqs@cpan.org。

#修改記錄

請參閱 Changes 檔案。

#版權與授權

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

此程式為自由軟體；您可以在與 Perl 相同的條款下重新散布或修改它。

Perldoc 瀏覽器由 Dan Book (DBOOK) 維護。請透過 GitHub 議題追蹤器 或 電子郵件 聯絡他，反映網站本身、搜尋或文件呈現的任何問題。

Perl 文件由 Perl 5 Porters 在 Perl 開發中維護。請透過 Perl 議題追蹤器、郵件清單 或 IRC 聯絡他們，反映文件內容或格式的任何問題。