module Zlib

要約

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

@see zlib(3)

目次

モジュール関数

• adler32
• adler32_combine
• crc_table
• crc32
• crc32_combine
• deflate
• inflate
• zlib_version

定数

• ASCII
• BEST_COMPRESSION
• BEST_SPEED
• BINARY
• DEF_MEM_LEVEL
• DEFAULT_COMPRESSION
• DEFAULT_STRATEGY
• FILTERED
• FINISH
• FULL_FLUSH
• HUFFMAN_ONLY
• MAX_MEM_LEVEL
• MAX_WBITS
• NO_COMPRESSION
• NO_FLUSH
• OS_AMIGA
• OS_ATARI
• OS_CODE
• OS_CPM
• OS_MACOS
• OS_MSDOS
• OS_OS2
• OS_QDOS
• OS_RISCOS
• OS_TOPS20
• OS_UNIX
• OS_UNKNOWN
• OS_VMCMS
• OS_VMS
• OS_WIN32
• OS_ZSYSTEM
• SYNC_FLUSH
• UNKNOWN
• VERSION
• ZLIB_VERSION

モジュール関数

adler32(string = nil, adler = nil) -> Integer[permalink][rdoc][edit]

adler32(io, adler = nil) -> Integer

string の Adler-32 チェックサムを計算し、adler を更新した値を返します。string が省略された場合は Adler-32 チェックサムの初期値を返します。adler が省略された場合は adler に初期値が与えらたものとして計算します。

[PARAM] string:

string の Adler-32 チェックサムが計算されます。

[PARAM] io:

IO が指定された場合は IO#read で nil を返すまで読み込んで、読み込んだデータ全体の Adler-32 チェックサムが計算されます。

[PARAM] adler:

adler を整数で指定します。

adler32_combine(adler1, adler2, length) -> Integer[permalink][rdoc][edit]

与えられた二つの Adler-32 チェックサムを一つにつなげます。

[PARAM] adler1:

Adler-32 チェックサムを指定します。

[PARAM] adler2:

Adler-32 チェックサムを指定します。

[PARAM] length:

adler2 を生成するのに使用した文字列の長さを指定します。

crc32(string = nil, crc = nil) -> Integer[permalink][rdoc][edit]

crc32(io, crc = nil) -> Integer

string の CRC チェックサムを計算し、crc を更新した値を返します。string が省略された場合は CRC チェックサムの初期値を返します。crc が省略された場合は crc に初期値が与えらたものとして計算します。

[PARAM] string:

string の CRC チェックサムが計算されます。

[PARAM] io:

IO が指定された場合は IO#read で nil を返すまで読み込んで、読み込んだデータ全体の CRC チェックサムが計算されます。

[PARAM] crc:

crc を整数で指定します。

crc32_combine(crc1, crc2, length) -> Integer[permalink][rdoc][edit]

与えられた二つの CRC-32 チェックサムを一つにつなげます。

[PARAM] crc1:

CRC-32 チェックサムを指定します。

[PARAM] crc2:

CRC-32 チェックサムを指定します。

[PARAM] length:

crc2 を生成するのに使用した文字列の長さを指定します。

crc_table -> Array[permalink][rdoc][edit]

CRC チェックサムの計算に用いるテーブルを配列で返します。

deflate(string, level = Zlib::DEFAULT_COMPRESSION) -> String[permalink][rdoc][edit]

引数 string を圧縮します。Zlib::Deflate.deflate と同じです。

[PARAM] string:

圧縮する文字列を指定します。

[PARAM] level:

圧縮の水準を詳細に指定します。有効な値は Zlib::NO_COMPRESSION, Zlib::BEST_SPEED, Zlib::BEST_COMPRESSION, Zlib::DEFAULT_COMPRESSION 及び 0 から 9 の整数です。

[SEE_ALSO] Zlib::Deflate.deflate

inflate(string) -> String[permalink][rdoc][edit]

引数 string を展開します。Zlib::Inflate.inflate と同じです。

[PARAM] string:

展開する文字列を指定します。

[EXCEPTION] Zlib::NeedDict:

展開に辞書が必要な場合に発生します。

[SEE_ALSO] Zlib::Inflate.inflate

zlib_version -> String[permalink][rdoc][edit]

zlib ライブラリのバージョンを表す文字列を返します。

定数

ASCII -> Integer[permalink][rdoc][edit]

Zlib::ZStream#data_type の返す、データタイプを表す整数です。

BEST_COMPRESSION -> Integer[permalink][rdoc][edit]

Zlib::Deflate.new や Zlib::Deflate#deflate 等に渡す、圧縮レベルを表す整数です。

BEST_SPEED -> Integer[permalink][rdoc][edit]

Zlib::Deflate.new や Zlib::Deflate#deflate 等に渡す、圧縮レベルを表す整数です。

BINARY -> Integer[permalink][rdoc][edit]

Zlib::ZStream#data_type の返す、データタイプを表す整数です。

DEFAULT_COMPRESSION -> Integer[permalink][rdoc][edit]

Zlib::Deflate.new や Zlib::Deflate#deflate 等に渡す、圧縮レベルを表す整数です。

DEFAULT_STRATEGY -> Integer[permalink][rdoc][edit]

Zlib::Deflate.new や Zlib::Deflate#params に渡す、圧縮方法を表す整数です。

DEF_MEM_LEVEL -> Integer[permalink][rdoc][edit]

Zlib::Deflate.new 等に渡す、memory level を表す整数です。

FILTERED -> Integer[permalink][rdoc][edit]

Zlib::Deflate.new や Zlib::Deflate#params に渡す、圧縮方法を表す整数です。

FINISH -> Integer[permalink][rdoc][edit]

Zlib::Deflate#deflate 等に渡す、ストリームの出力を制御するための整数です。

FULL_FLUSH -> Integer[permalink][rdoc][edit]

Zlib::Deflate#deflate 等に渡す、ストリームの出力を制御するための整数です。

HUFFMAN_ONLY -> Integer[permalink][rdoc][edit]

Zlib::Deflate.new や Zlib::Deflate#params に渡す、圧縮方法を表す整数です。

MAX_MEM_LEVEL -> Integer[permalink][rdoc][edit]

Zlib::Deflate.new 等に渡す、memory level を表す整数です。

MAX_WBITS[permalink][rdoc][edit]

Zlib::Deflate.new や Zlib::Inflate.new での windowBits のデフォルト値です。

NO_COMPRESSION -> Integer[permalink][rdoc][edit]

Zlib::Deflate.new や Zlib::Deflate#deflate 等に渡す、圧縮レベルを表す整数です。

NO_FLUSH -> Integer[permalink][rdoc][edit]

Zlib::Deflate#deflate 等に渡す、ストリームの出力を制御するための整数です。

OS_AMIGA -> Integer[permalink][rdoc][edit]

OS の種類を表す定数です。

OS_ATARI -> Integer[permalink][rdoc][edit]

OS の種類を表す定数です。

OS_CODE -> Integer[permalink][rdoc][edit]

Zlib::GzipFile#os_code メソッドの返す値です。

OS_CPM -> Integer[permalink][rdoc][edit]

OS の種類を表す定数です。

OS_MACOS -> Integer[permalink][rdoc][edit]

OS の種類を表す定数です。

OS_MSDOS -> Integer[permalink][rdoc][edit]

OS の種類を表す定数です。

OS_OS2 -> Integer[permalink][rdoc][edit]

OS の種類を表す定数です。

OS_QDOS -> Integer[permalink][rdoc][edit]

OS の種類を表す定数です。

OS_RISCOS -> Integer[permalink][rdoc][edit]

OS の種類を表す定数です。

OS_TOPS20 -> Integer[permalink][rdoc][edit]

OS の種類を表す定数です。

OS_UNIX -> Integer[permalink][rdoc][edit]

OS の種類を表す定数です。

OS_UNKNOWN -> Integer[permalink][rdoc][edit]

OS の種類を表す定数です。

OS_VMCMS -> Integer[permalink][rdoc][edit]

OS の種類を表す定数です。

OS_VMS -> Integer[permalink][rdoc][edit]

OS の種類を表す定数です。

OS_WIN32 -> Integer[permalink][rdoc][edit]

OS の種類を表す定数です。

OS_ZSYSTEM -> Integer[permalink][rdoc][edit]

OS の種類を表す定数です。

SYNC_FLUSH -> Integer[permalink][rdoc][edit]

Zlib::Deflate#deflate 等に渡す、ストリームの出力を制御するための整数です。

UNKNOWN -> Integer[permalink][rdoc][edit]

Zlib::ZStream#data_type の返す、データタイプを表す整数です。

VERSION -> String[permalink][rdoc][edit]

Ruby/zlib のバージョンを表す文字列です。

ZLIB_VERSION -> String[permalink][rdoc][edit]

zlib.h のバージョンを表す文字列です。