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

class Zlib::GzipFile

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

要約

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

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

目次

特異メソッド
new open wrap
インスタンスメソッド
close closed? to_io comment crc finish level mtime orig_name os_code path sync sync=

特異メソッド

new(*args) -> ()[permalink][rdoc]

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

[SEE_ALSO] Zlib::GzipReader.new, Zlib::GzipWriter.new

open(*args) {|gz| ... } -> ()[permalink][rdoc]

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

[SEE_ALSO] Zlib::GzipReader.open, Zlib::GzipWriter.open

wrap(*args) {|gz| ... } -> ()[permalink][rdoc]

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

[SEE_ALSO] Zlib::GzipReader.wrap,Zlib::GzipWriter.wrap

インスタンスメソッド

close -> IO[permalink][rdoc]

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

closed? -> bool[permalink][rdoc]
to_io -> IO

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

[SEE_ALSO] IO#to_io, IO#closed?

comment -> String | nil[permalink][rdoc]

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

crc -> Integer[permalink][rdoc]

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

finish -> IO[permalink][rdoc]

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

level -> Integer[permalink][rdoc]

圧縮レベルを返します。

mtime -> Time[permalink][rdoc]

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

orig_name -> String | nil[permalink][rdoc]

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

os_code -> Integer[permalink][rdoc]

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

path -> String[permalink][rdoc]

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

sync -> bool[permalink][rdoc]
sync=(flag)

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

[SEE_ALSO] IO#sync, IO#sync