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

instance method Zlib::GzipWriter#comment=

comment=(string)[permalink][rdoc]

gzip ファイルのヘッダーに記録するコメントを指定します。

Zlib::GzipWriter#write 等の書き込み系メソッドを 呼んだ後で指定しようとすると Zlib::GzipFile::Error 例外が 発生します。

[PARAM] string:

gzip ファイルのヘッダーに記録するコメントを文字列で指定します。

[RETURN]

string を返します。

require 'zlib'

filename='hoge1.gz'
fw = File.open(filename, "w")
Zlib::GzipWriter.wrap(fw, Zlib::BEST_COMPRESSION){|gz|
  gz.comment = "hogehoge"
  p gz.comment #=> "hogehoge"
}
fr = File.open(filename)
Zlib::GzipReader.wrap(fr){|gz|
  puts gz.comment #=> hogehoge
}