class

Zstd::Decompress::IO

Inherits IO / Reference / Object

Constants

INPUT_BUFFER_SIZE = Lib.d_stream_in_size.to_i

Constructors

new(io : ::IO, sync_close : Bool = false, *, input_buffer : Bytes | Nil = nil, dict : Zstd::Dict | Nil = nil)
Source

Class methods

open(io, sync_close = false, *, input_buffer = nil, dict = nil, &)
Source

Instance methods

close

Closes this IO.

IO defines this is a no-op method, but including types may override.

Source
closed?

Returns true if this writer is closed.

Source
dict(*args, **options)
Source
dict(*args, **options, &)
Source
dict=(arg)
Source
read(slice : Bytes)

Reads at most slice.size bytes from this IO into slice. Returns the number of bytes read, which is 0 if and only if there is no more data to read (so checking for 0 is the way to detect end of file).

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
Source
sync_close=(sync_close : Bool)

Whether to close the enclosed IO when closing this reader.

Source
sync_close?

Whether to close the enclosed IO when closing this reader.

Source
write(slice : Bytes) : Nil

Writes the contents of slice into this IO.

io = IO::Memory.new
slice = Bytes.new(4) { |i| ('a'.ord + i).to_u8 }
io.write(slice)
io.to_s # => "abcd"
Source

Nested types