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

class Zlib::GzipFile

クラス・モジュールの継承リスト: Zlib::GzipFile < Object < Kernel < BasicObject

要約

gzip 形式の圧縮ファイルを扱う抽象クラス。具体的な読み込み/書き込み操作は、それぞれサブクラスの Zlib::GzipReader, Zlib::GzipWriter で定義されています。

IO クラスのインスタンス (又は IO クラスのインスタンスと同じメソッドを持つオブジェクト) と関連付けて使用します。

特異メソッド

定義 説明
new(*args) -> ()

直接使用しません。通常、具体的な読み書きをおこなうためには、 Zlib::GzipReader.new もしくは、 Zlib::GzipWriter.new を使用します。

open(*args) {|gz| ... } -> ()

直接使用しません。通常、具体的な読み書きをおこなうためには、 Zlib::GzipReader.open もしくは、Zlib::GzipWriter.open を使用します。

wrap(*args) {|gz| ... } -> ()

直接使用しません。通常、具体的な読み書きをおこなうためには、 Zlib::GzipReader.wrap もしくは、Zlib::GzipWriter.wrap を使用します。

インスタンスメソッド

定義 説明
close -> IO

GzipFile オブジェクトをクローズします。このメソッドは関連付けられている IO オブジェクトの close メソッドを呼び出します。関連付けられている IO オブジェクトを返します。

closed? -> bool
to_io -> IO

IO クラスの同名メソッドと同じ。

comment -> String | nil

gzip ファイルのヘッダーに記録されているコメントを返します。コメントが存在しない場合は nil を返します。

crc -> Integer

圧縮されていないデータの CRC 値を返します。

finish -> IO

GzipFile オブジェクトをクローズします。Zlib::GzipFile#closeと違い、このメソッドは関連付けられている IO オブジェクトの close メソッドを呼び出しません。関連付けられている IO オブジェクトを返します。

level -> Integer

圧縮レベルを返します。

mtime -> Time

gzip ファイルのヘッダーに記録されている最終更新時間を返します。

orig_name -> String | nil

gzip ファイルのヘッダーに記録されている元ファイル名を返します。ファイル名が記録されていない場合は nil を返します。

os_code -> Integer

gzip ファイルのヘッダーに記録されている OS コード番号を返します。

path -> String

関連付けられている IO オブジェクトのパスを返します。このメソッドは IO オブジェクトが path というメソッドを持つ場合のみ定義されます。

sync -> bool
sync=(flag)

IO クラスと同じ。flag が真の時、関連付けられている IO オブジェクトが flush メソッドを持っていなければなりません。また、true にすると圧縮率が著しく低下します。

継承したメソッド

! != __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? itself marshal_dump marshal_load method methods 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_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_ENGINE_VERSION ::RUBY_PATCHLEVEL ::RUBY_PLATFORM ::RUBY_RELEASE_DATE ::RUBY_REVISION ::RUBY_VERSION ::SCRIPT_LINES__ ::STDERR ::STDIN ::STDOUT ::TOPLEVEL_BINDING ::TRUE