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

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

インスタンスメソッド

定義 説明
adler -> Integer

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

avail_in -> Integer

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

avail_out -> Integer

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

avail_out=(size)

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

close -> nil
end -> nil

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

closed? -> bool
ended? -> bool

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

data_type -> Integer

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

finish -> String

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

finished? -> bool
stream_end? -> bool

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

flush_next_in -> String

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

flush_next_out -> String

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

reset -> nil

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

total_in -> Integer

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

total_out -> Integer

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

継承したメソッド

! != __id__ __send__ instance_eval instance_exec method_missing singleton_method_added singleton_method_removed singleton_method_undefined !~ <=> == === =~ _dump class clone define_singleton_method display enum_for eql? equal? extend freeze frozen? hash initialize initialize_copy inspect instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? marshal_dump marshal_load method methods must_be must_be_close_to must_be_empty must_be_instance_of must_be_kind_of must_be_nil must_be_same_as must_be_within_epsilon must_equal must_include must_match must_raise must_respond_to must_send must_throw nil? object_id pretty_inspect pretty_print pretty_print_cycle pretty_print_inspect pretty_print_instance_variables private_methods protected_methods psych_to_yaml public_method public_methods public_send remove_instance_variable respond_to? respond_to_missing? send singleton_class singleton_method singleton_methods taint tainted? tap to_a to_ary to_hash to_int to_io to_proc to_regexp to_s to_str trust untaint untrust untrusted? .yaml_tag ::ARGF ::ARGV ::DATA ::ENV ::FALSE ::NIL ::RUBY_COPYRIGHT ::RUBY_DESCRIPTION ::RUBY_ENGINE ::RUBY_PATCHLEVEL ::RUBY_PLATFORM ::RUBY_RELEASE_DATE ::RUBY_REVISION ::RUBY_VERSION ::SCRIPT_LINES__ ::STDERR ::STDIN ::STDOUT ::TOPLEVEL_BINDING ::TRUE