Ruby 2.1.0 リファレンスマニュアル > ライブラリ一覧 > zlibライブラリ > Zlib::ZStreamクラス

class Zlib::ZStream

クラスの継承リスト: Zlib::ZStream < Object < Kernel < BasicObject

要約

圧縮データを扱うストリームを表す抽象クラスです。 具体的な圧縮/展開の操作は、それぞれサブクラスの Zlib::Deflate, Zlib::Inflate で定義されています。

Zlib::ZStream オブジェクトは、ストリーム (struct zstream) の 入力側 (next_in) と出力側 (next_out) にそれぞれ可変長の バッファを持ちます。以下、入力側のバッファを「入力バッファ」、 出力側のバッファを「出力バッファ」と呼びます。

Zlib::ZStream オブジェクトに入力されたデータは、一旦入力バッファの 末尾にストアされた後、ストリームからの出力がなくなるまで (処理後 avail_out > 0 となるまで) 入力バッファの先頭から順に処理されます。 処理の間、出力バッファは全出力を保持するために必要に応じて自動的に 確保・拡張されます。

いくつかのメソッドは、出力バッファ内のデータを取り出し、 String オブジェクトとして返します。

以上を図示すると次のようになります:

+================ an instance of Zlib::ZStream ================+
||                                                            ||
||     +--------+          +-------+          +--------+      ||
||  +--| output |<---------|zstream|<---------| input  |<--+  ||
||  |  | buffer |  next_out+-------+next_in   | buffer |   |  ||
||  |  +--------+                             +--------+   |  ||
||  |                                                      |  ||
+===|======================================================|===+
    |                                                      |
    v                                                      |
"output data"                                         "input data"

入力バッファの内容を処理している最中にエラーが発生した場合、 Zlib::Error のサブクラスの例外が発生します。その時、 入力/出力バッファは共に、エラーが発生した時点の状態をそのまま 保持します。

目次

特異メソッド
new
インスタンスメソッド
adler avail_in avail_out avail_out= close end closed? ended? data_type finish finished? stream_end? flush_next_in flush_next_out reset total_in total_out

特異メソッド

new -> ()[permalink][rdoc]

直接使用しません。 通常、具体的な圧縮/展開を行う場合は、 Zlib::Deflate.new もしくは、Zlib::Inflate.new を使用します。

[SEE_ALSO] Zlib::Deflate.new, Zlib::Inflate.new

インスタンスメソッド

adler -> Integer[permalink][rdoc]

adler-32 チェックサムを返します。

avail_in -> Integer[permalink][rdoc]

入力バッファに溜っているデータのバイト数を返します。通常は 0 です。

avail_out -> Integer[permalink][rdoc]

出力バッファの空き用量をバイト数で返します。 空きは必要な時に動的に確保されるため、通常は 0 です。

avail_out=(size)[permalink][rdoc]

出力側のバッファに size バイトの空きを確保します。 すでに size バイト以上の空きがある場合、バッファは 縮められます。空きは必要な時に動的に確保されるため、通常 このメソッドを使う必要はありません。

[PARAM] size:
出力バッファのサイズを整数で指定します。
[RETURN]
size を返します。
close -> nil[permalink][rdoc]
end -> nil

ストリームを閉じます。 以後、このストリームにアクセスすることはできなくなります。

closed? -> bool[permalink][rdoc]
ended? -> bool

ストリームが閉じられている時に真を返します。

data_type -> Fixnum[permalink][rdoc]

ストリームに入力されたデータの形式を推測します。 返り値は Zlib::BINARY, Zlib::ASCII, Zlib::UNKNOWN の いずれかです。

finish -> String[permalink][rdoc]

ストリームへの入力を終了し、出力バッファをフラッシュします。 より具体的な振る舞いは Zlib::Deflate#finish, Zlib::Inflate#finish を参照して下さい。

[SEE_ALSO] Zlib::Deflate#finish,Zlib::Inflate#finish

finished? -> bool[permalink][rdoc]
stream_end? -> bool

ストリームへの入力が終了している時に真を返します。

flush_next_in -> String[permalink][rdoc]

入力バッファに残っているデータを強制的に取り出します。

flush_next_out -> String[permalink][rdoc]

出力バッファに残っているデータを強制的に取り出します。

reset -> nil[permalink][rdoc]

ストリームの状態をリセットします。 入力/出力バッファ内に残っていたデータは破棄されます。

total_in -> Integer[permalink][rdoc]

ストリームに入力されたデータの総バイト数を返します。

total_out -> Integer[permalink][rdoc]

ストリームの出力したデータの総バイト数を返します。