class

Compress::BZ2::Reader

Inherits IO::Buffered < IO < Reference < Object

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, it reads data from the underlying IO, decompresses it, and returns it to the caller.

Example: decompress a file

require "bz2"

string = File.open("file.bz2") do |file|
  Compress::BZ2::Reader.open(file) do |bz2|
    bz2.gets_to_end
  end
end
pp string

Constructors

new(io : IO, small : Bool = false, sync_close : Bool = false)

Creates an instance of BZ2::Reader.

small, when true, makes decompression use a slower algorithm that needs less memory - the same trade-off bzip2 -s makes.

Source

new(filename : String)

Creates a new reader from the given filename.

Source

Class methods

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

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

Source

open(filename : String, small : Bool = false, &)

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

Source

Instance methods

closed?

Returns true if this reader is closed.

Source

sync_close=(sync_close : Bool)

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

Source

sync_close?

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

Source

unbuffered_close

Closes this reader.

Source

unbuffered_flush

Flushes the wrapped IO.

TODO: Add return type restriction Nil

Source

unbuffered_read(slice : Bytes)

Reads at most slice.size bytes from the wrapped IO into slice. Returns the number of bytes read.

TODO: Add return type restriction Int32

Source

unbuffered_rewind

Rewinds the wrapped IO.

TODO: Add return type restriction Nil

Source

unbuffered_write(slice : Bytes)

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

Source