class RemiLib::Compression::BZip2::Reader

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

Overview

A read-only IO object to decompress data in the bzip2 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.

Example of a simple decompressor:

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

Included Modules

• IO::Buffered

Defined in:

Constructors

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

  Creates an instance of Flate::Reader.

Class Method Summary

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

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

Instance Method Summary

• #closed? : Bool

  Returns true if this reader is closed.

• #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.

• #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.

• #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

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

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