class Compress::Gzip::Writer

• Compress::Gzip::Writer
• IO
• Reference
• Object

Overview

Awrite-onlyIO object to compress data in the gzip format.

Instances of this classwrap anotherIO object. When youwrite to this instance, it compresses the data andwrites it to the underlyingIO.

NOTE unless createdwith a block,#close must be invoked after all data has beenwritten to aGzip::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

Defined in:

Constructors

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

  Creates a newwriter to the givenio.

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

  Creates a newwriter to the givenfilename.

Class Method Summary

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

  Creates a newwriter to the givenio, yields it to the given block, and closes it at the end.

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

  Creates a newwriter to the givenfilename, yields it to the given block, and closes it at the end.

Instance Method Summary

• #close : Nil

  Closes thiswriter.

• #closed? : Bool

  Returnstrue if thiswriter is closed.

• #flush : Nil

  Flushes data, forcingwriting the gzip header if no data has beenwritten yet.

• #header : Compress::Gzip::Header

  The header towrite to the gzip stream.

• #read(slice : Bytes) : NoReturn

  Always raisesIO::Error because this is awrite-onlyIO.

• #sync_close=(sync_close : Bool)

  Whether to close the enclosedIOwhen closing thiswriter.

• #sync_close? : Bool

  Whether to close the enclosedIOwhen closing thiswriter.

• #write(slice : Bytes) : Nil

  SeeIO#write.

Constructor Detail

Class Method Detail

Instance Method Detail