class Compress::LZ4::Reader

• Compress::LZ4::Reader
• IO
• Reference
• Object

Overview

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

Defined in:

Constructors

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

  Creates a new reader from the given filename.

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.

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

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

• .open(filename : String, &)

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

Instance Method Summary

• #close

  Closes this IO.

• #closed? : Bool

  Returns true if this IO is closed.

• #compressed_bytes : UInt64
• #compression_ratio : Float64

  Uncompressed bytes outputted / compressed bytes read so far in the stream

• #finalize
• #flush

  Flushes buffered data, if any.

• #read(slice : Bytes) : Int32

  Reads at most slice.size bytes from this IO into slice.

• #rewind

  Rewinds this IO.

• #sync_close=(sync_close : Bool)
• #sync_close? : Bool
• #uncompressed_bytes : UInt64
• #write(slice : Bytes) : Nil

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

Constructor Detail

Class Method Detail

Instance Method Detail

io = IO::Memory.new "hello"
slice = Bytes.new(4)
io.read(slice) # => 4
slice          # => Bytes[104, 101, 108, 108]
io.read(slice) # => 1
slice          # => Bytes[111, 101, 108, 108]
io.read(slice) # => 0