class

Zstd::Compress::IO

Inherits IO / Reference / Object

Constants

OUTPUT_BUFFER_SIZE = Lib.c_stream_out_size.to_i

Constructors

new(io : ::IO, level : Int32 = LEVEL_DEFAULT, *, output_buffer : Bytes | Nil = nil)

output_buffer: If provided should be OUTPUT_BUFFER_SIZE bytes.

Source

Class methods

open(io, level : Int32 = LEVEL_DEFAULT, *, output_buffer : Bytes | Nil = nil, &)
Source

Instance methods

checksum(*args, **options)
Source
checksum(*args, **options, &)
Source
checksum=(arg)
Source
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
level(*args, **options)

Compression level (0..22)

Source
level(*args, **options, &)

Compression level (0..22)

Source
level=(arg)

Compression level (0..22)

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 writer.

Source
sync_close?

Whether to close the enclosed IO when closing this writer.

Source
threads(*args, **options)
Source
threads(*args, **options, &)
Source
threads=(arg)
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