class Compress::Gzip::Reader

• Compress::Gzip::Reader
• IO
• Reference
• Object

Overview

A read-only IO object to decompress data in the gzip format.

Instances of this class wrap another IO object. When you read from this instance instance, it reads data from the underlying IO, decompresses it, and returns it to the caller.

NOTE A gzip stream can contain zero or more members. If it contains no members, #header will be nil. If it contains one or more members, only the first header will be recorded here. This is because gzipping multiple members is not common as one usually combines gzip with tar. If, however, multiple members are present then reading from this reader will return the concatenation of all the members.

Example: decompress a gzip file

require "compress/gzip"

File.write("file.gzip", Bytes[31, 139, 8, 0, 0, 0, 0, 0, 0, 3, 75, 76, 74, 6, 0, 194, 65, 36, 53, 3, 0, 0, 0])

string = File.open("file.gzip") do |file|
  Compress::Gzip::Reader.open(file) do |gzip|
    gzip.gets_to_end
  end
end
string # => "abc"

Included Modules

• IO::Buffered

Defined in:

Constructors

• .new(io : IO, sync_close : Bool = false)

  Creates a new reader from the given io.

• .new(filename : String)

  Creates a new reader from the given filename.

Class Method Summary

• .open(io : IO, sync_close = false, &)

  Creates a new reader from the given io, yields it to the given block, and closes it at the end.

• .open(filename : String, &)

  Creates a new reader from the given filename, yields it to the given block, and closes it at the end.

Instance Method Summary

• #closed? : Bool

  Returns true if this reader is closed.

• #header : Header | Nil

  Returns the first header in the gzip stream, if any.

• #sync_close=(sync_close : Bool)

  Whether to close the enclosed IO when closing this reader.

• #sync_close? : Bool

  Whether to close the enclosed IO when closing this reader.

• #unbuffered_close : Nil

  Closes this reader.

• #unbuffered_flush : NoReturn

  Flushes the wrapped IO.

• #unbuffered_read(slice : Bytes) : Int32

  See IO#read.

• #unbuffered_rewind : Nil

  Rewinds the wrapped IO.

• #unbuffered_write(slice : Bytes) : NoReturn

  Always raises IO::Error because this is a read-only IO.

Constructor Detail

Class Method Detail

Instance Method Detail