A write-only IO object to compress data in the zlib 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 a Zlib::Writer instance.
Constructors
new(io :
IO, level :
Int32 =
Zlib::DEFAULT_COMPRESSION, sync_close :
Bool = false, dict :
Bytes |
Nil = nil)
Creates a new writer to the given io.
new(filename :
String, level =
Zlib::DEFAULT_COMPRESSION, dict :
Bytes |
Nil = nil)
Creates a new writer to the given filename.
Class methods
open(io :
IO, level =
Zlib::DEFAULT_COMPRESSION, sync_close = false, dict :
Bytes |
Nil = nil, &)
Creates a new writer to the given io, yields it to the given block,
and closes it at the end.
open(filename :
String, level =
Zlib::DEFAULT_COMPRESSION, dict :
Bytes |
Nil = nil, &)
Creates a new writer to the given filename, yields it to the given block,
and closes it at the end.
Instance methods
close
Closes this writer. Must be invoked after all data has been written.
closed?
Returns true if this writer is closed.
flush
Flushes data, forcing writing the zlib header if no
data has been written yet.
See IO#flush.
read(slice :
Bytes) :
NoReturn Always raises IO::Error because this is a write-only IO.
sync_close=(sync_close :
Bool)
Whether to close the enclosed IO when closing this writer.
sync_close?
Whether to close the enclosed IO when closing this writer.