Gzip::Writer

class Gzip::Writer

• Gzip::Writer
• Reference
• Object

Overview

A write-only IO object to compress data in the gzip format.

Instances of this class wrap another IO object. When you write to this instance, it compresses the data and writes it to the underlying IO.

NOTE unless created with a block, #close must be invoked after all data has been written to a Gzip::Writer instance.

Example: compress a file

require "zlib"

File.write("file.txt", "abc")

File.open("./file.txt", "r") do |input_file|
  File.open("./file.gzip", "w") do |output_file|
    Gzip::Writer.open(output_file) do |gzip|
      IO.copy(input_file, gzip)
    end
  end
end

Included Modules

• IO

Defined in:

Class Method Summary

• .new(io : IO, level = Gzip::DEFAULT_COMPRESSION, sync_close = false)

  Creates a new writer to the given io.

• .new(filename : String, level = Gzip::DEFAULT_COMPRESSION)

  Creates a new writer to the given filename.

• .open(io : IO, level = Gzip::DEFAULT_COMPRESSION, sync_close = false, &block)

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

• .open(filename : String, level = Gzip::DEFAULT_COMPRESSION, &block)

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

Instance Method Summary

• #close

  Closes this writer.

• #closed? : Bool

  Returns true if this writer is closed.

• #flush

  Flushes data, forcing writing the gzip header if no data has been written yet.

• #header : Gzip::Header

  The header to write to the gzip stream.

• #read(slice : Bytes)

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

• #sync_close=(sync_close)

  Whether to close the enclosed IO when closing this writer.

• #sync_close? : Bool

  Whether to close the enclosed IO when closing this writer.

• #write(slice : Bytes) : Nil

  See IO#write.

Class Method Detail

Instance Method Detail