Module: Zlib

Defined in:

ext/zstdlib_c/ruby/zlib-2.2/zstdlib.c,
ext/zstdlib_c/ruby/zlib-2.3/zstdlib.c,
ext/zstdlib_c/ruby/zlib-2.4/zstdlib.c,
ext/zstdlib_c/ruby/zlib-2.5/zstdlib.c,
ext/zstdlib_c/ruby/zlib-2.6/zstdlib.c,
ext/zstdlib_c/ruby/zlib-2.7/zstdlib.c,
ext/zstdlib_c/ruby/zlib-3.0/zstdlib.c,
ext/zstdlib_c/ruby/zlib-3.1/zstdlib.c,
ext/zstdlib_c/ruby/zlib-3.2/zstdlib.c,
ext/zstdlib_c/ruby/zlib-3.3/zstdlib.c

Overview

This module provides access to the library[http://zlib.net]. Zlib is designed to be a portable, free, general-purpose, legally unencumbered -- that is, not covered by any patents -- lossless data-compression library for use on virtually any computer hardware and operating system.

The zlib compression library provides in-memory compression and decompression functions, including integrity checks of the uncompressed data.

The zlib compressed data format is described in RFC 1950, which is a wrapper around a deflate stream which is described in RFC 1951.

The library also supports reading and writing files in gzip (.gz) format with an interface similar to that of IO. The gzip format is described in RFC 1952 which is also a wrapper around a deflate stream.

The zlib format was designed to be compact and fast for use in memory and on communications channels. The gzip format was designed for single-file compression on file systems, has a larger header than zlib to maintain directory information, and uses a different, slower check method than zlib.

See your system's zlib.h for further information about zlib

== Sample usage

Using the wrapper to compress strings with default parameters is quite simple:

require "zstdlib"

data_to_compress = File.read("don_quixote.txt")

puts "Input size: #data_to_compressdata_to_compress.size" #=> Input size: 2347740

data_compressed = Zstdlib::Deflate.deflate(data_to_compress)

puts "Compressed size: #data_compresseddata_compressed.size" #=> Compressed size: 887238

uncompressed_data = Zstdlib::Inflate.inflate(data_compressed)

puts "Uncompressed data is: #uncompressed_data" #=> Uncompressed data is: The Project Gutenberg EBook of Don Quixote...

== Class tree

• Zstdlib::Deflate
• Zstdlib::Inflate
• Zstdlib::ZStream
• Zstdlib::Error
  • Zstdlib::StreamEnd
  • Zstdlib::NeedDict
  • Zstdlib::DataError
  • Zstdlib::StreamError
  • Zstdlib::MemError
  • Zstdlib::BufError
  • Zstdlib::VersionError
  • Zstdlib::InProgressError

(if you have GZIP_SUPPORT)

• Zstdlib::GzipReader
• Zstdlib::GzipWriter
• Zstdlib::GzipFile
• Zstdlib::GzipFile::Error
  • Zstdlib::GzipFile::LengthError
  • Zstdlib::GzipFile::CRCError
  • Zstdlib::GzipFile::NoFooter