Class: Zlib::GzipFile

Zlib::GzipFile is an abstract class for handling a gzip formatted compressed file. The operations are defined in the subclasses, Zlib::GzipReader for reading, and Zlib::GzipWriter for writing.

GzipReader should be used by associating an IO, or IO-like, object.

Methods

close closed? comment crc finish level mtime orig_name os_code sync sync= to_io wrap

Classes and Modules

Class Zlib::GzipFile::CRCError
Class Zlib::GzipFile::Error
Class Zlib::GzipFile::LengthError
Class Zlib::GzipFile::NoFooter

Public Class methods

wrap(...)

See Zlib::GzipReader#wrap and Zlib::GzipWriter#wrap.

Public Instance methods

close()

Closes the GzipFile object. This method calls close method of the associated IO object. Returns the associated IO object.

closed?()

Same as IO.

comment()

Returns comments recorded in the gzip file header, or nil if the comments is not present.

crc()

Returns CRC value of the uncompressed data.

finish()

Closes the GzipFile object. Unlike Zlib::GzipFile#close, this method never calls the close method of the associated IO object. Returns the associated IO object.

level()

Returns compression level.

mtime()

Returns last modification time recorded in the gzip file header.

orig_name()

Returns original filename recorded in the gzip file header, or nil if original filename is not present.

os_code()

Returns OS code number recorded in the gzip file header.

sync()

Same as IO.

sync = flag

Same as IO. If flag is true, the associated IO object must respond to the flush method. While sync mode is true, the compression ratio decreases sharply.

to_io()

Same as IO.

ruby-doc.org is a service of James Britt and Neurogami, a Ruby application development company in Phoenix, AZ.

Documentation content on ruby-doc.org is provided by remarkable members of the Ruby community.

For more information on the Ruby programming language, visit ruby-lang.org.

Want to help improve Ruby's API docs? See Ruby Documentation Guidelines.