class

Compress::Gzip::Writer

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 "compress/gzip"

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

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

Constructors

new(io : IO, level : Int32 = Compress::Gzip::DEFAULT_COMPRESSION, sync_close : Bool = false)

Creates a new writer to the given io.

Source

new(filename : String, level = Compress::Gzip::DEFAULT_COMPRESSION)

Creates a new writer to the given filename.

Source

Class methods

open(io : IO, level = Compress::Gzip::DEFAULT_COMPRESSION, sync_close = false, &)

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

Source

open(filename : String, level = Compress::Gzip::DEFAULT_COMPRESSION, &)

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

Source

Instance methods

Closes this writer. Must be invoked after all data has been written.

Source

closed?

Returns true if this writer is closed.

Source

flush

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

See IO#flush.

Source

header

The header to write to the gzip stream. It will be written just before the first write to this writer. Changes to the header after the first write are ignored.

Source

read(slice : Bytes) : NoReturn

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

Source

sync_close=(sync_close : Bool)

Whether to close the enclosed IO when closing this writer.

Source

sync_close?

Whether to close the enclosed IO when closing this writer.

Source

write(slice : Bytes) : Nil

See IO#write.

Source