library zlib

要約

zlib を Ruby から使うための拡張ライブラリです。 gzip ファイルの読み書きもサポートします。

参考

標準添付ライブラリ紹介 【第 11 回】zlib

https://magazine.rubyist.net/articles/0018/0018-BundledLibraries.html

@see https://zlib.net/

クラス

Zlib::GzipFile

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

  Zlib::GzipReader

gzip 形式の圧縮ファイルを読み込むラッパークラスです。 IO クラスのインスタンス (又は IO クラスのインスタンスと同じメソッドを持つオブジェクト) と関連付けて使用します。

  Zlib::GzipWriter

gzip 形式の圧縮ファイルを書き出すラッパークラスです。 IO クラスのインスタンス (又は IO クラスのインスタンスと同じメソッドを持つオブジェクト) と関連付けて使用します。

Zlib::ZStream

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

  Zlib::Deflate

入力データを圧縮するストリームのクラスです。

  Zlib::Inflate

入力データを展開するストリームのクラス。Zlib::Deflate と違い、このクラスのインスタンスを複製 (clone, dup) することはできません。

モジュール

Zlib

zlib ライブラリに含まれている雑多な機能を提供するモジュール。各モジュール関数の詳細は zlib.h を参照して下さい。

例外クラス

Zlib::Error

ライブラリ zlib の発行する全ての例外のスーパークラスです。

  Zlib::BufError

出力バッファのサイズが不足している場合に発生します。

  Zlib::DataError

入力データが壊れている場合などに発生します。

  Zlib::GzipFile::Error

gzip ファイルを処理している間にエラーが生じた時に発生する全ての例外のスーパークラスです。

   Zlib::GzipFile::CRCError

フッターに記録されている CRC 値と実際に展開したデータの CRC 値が異なる時に発生します。

   Zlib::GzipFile::LengthError

フッターに記録されているデータ長と実際に展開したデータの長さが異なる時に発生します。

   Zlib::GzipFile::NoFooter

gzip ファイルにフッターが無い時に発生します。

  Zlib::MemError

メモリ不足である場合に発生します。

  Zlib::NeedDict

展開に用いる辞書が指定されていない場合に発生します。

  Zlib::StreamEnd

全ての入力データが処理済みで全ての出力が取り出し済みである場合に発生します。

  Zlib::StreamError

ストリームの状態が異常である場合や、圧縮レベルの指定が無効なものである場合に発生します。

  Zlib::VersionError

zlib ライブラリのバージョンがこのライブラリの想定しているバージョンと互換でない場合に発生します。