BZ2::Reader (Class)

In: bz2.rb
Parent: Object

The class for decompressing data. Data can be read directly from a String, or from an object which must respond to read

Methods

close   close!   closed?   each   each_line   eof   eoz   finish   foreach   getc   gets   lineno   lineno=   new   open   read   readline   readlines   readlines   to_io   ungetc   ungets   unused   unused=  

Included Modules

Enumerable

Public Class methods

Uncompress the file and call the block for each line, where lines are separated by separator

Associate a new bz2 reader with object.

object must be a String which contains compressed data, or an object which respond to read(size)

If small is true, the library will use an alternative decompression algorithm which uses less memory but at the cost of decompressing more slowly

Call Kernel#open(filename), and associate it a new BZ2::Reader. The bz2 object is passed as an argument to the block.

The object is closed at the end of the block

See new for small

Uncompress the file and reads the entire file as individual lines, and returns those lines in an array. Lines are separated by separator

Public Instance methods

Terminate the uncompression and close the bz2

Terminate the uncompression, close the bz2 and the associated object

Return true if the file is closed

Execute the block for each line, where lines are separated by the optional separator

Return true at end of file

"End Of Zip". Return true at the end of the zip component

Terminate the uncompression of the current zip component, and keep the bz2 active (to read another zip component)

Get the next 8-bit byte (0..255). Returns nil if called at end of file.

Reads the next line; lines are separated by separator. Returns nil if called at end of file.

Return the current line number

Manually sets the current line number to the given value

Read at most number characters Returns nil if called at end of file

Reads the next line; lines are separated by separator. Raise an error at end of file

Reads all of the lines, and returns them in anArray. Lines are separated by the optional separator

return the associated object

Push back one character

Push back the string

Return the String read by BZ2::Reader but not used in the uncompression

Initialize the uncompression with the String str

[Validate]