class RemiLib::Compression::BZip2::Writer

• RemiLib::Compression::BZip2::Writer
• IO
• Reference
• Object

Overview

A write-only IO object to compress data in the BZip2 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 an instance.

Example of a simple compressor:

# Compress `file` and save to `output`.
File.open(bzip2file, "rb") do |file|
  File.open(outputfile, "wb") do |output|
    RemiLib::Compression::BZip2::Writer.open(output) do |bzio|
      IO.copy(bzio, output)
    end
  end
end

Defined in:

Constructors

• .new(output : IO, level : Int32 = DEFAULT_COMPRESSION_LEVEL, sync_close : Bool = false)

  Creates an instance of Writer.

Class Method Summary

• .open(io : IO, level : Int32 = DEFAULT_COMPRESSION_LEVEL, sync_close : Bool = false, &)

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

Instance Method Summary

• #close : Nil

  Closes this writer.

• #closed? : Bool

  Returns true if this IO is closed.

• #flush : Nil

  Not implemented for a BZip2 Writer, always raises an exception.

• #inspect(io : IO) : Nil

  Appends a String representation of this object which includes its class name, its object address and the values of all instance variables.

• #read(slice : Bytes) : NoReturn

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

• #sync_close=(sync_close : Bool)

  If #sync_close? is true, closing this IO will close the underlying IO.

• #sync_close? : Bool

  If #sync_close? is true, closing this IO will close the underlying IO.

• #write(slice : Bytes) : Nil

  See IO#write.

Constructor Detail

Class Method Detail

Instance Method Detail

class Person
  def initialize(@name : String, @age : Int32)
  end
end

Person.new("John", 32).inspect # => #<Person:0x10fd31f20 @name="John", @age=32>