class Zstd::Compress::IO

Defined in:

Constant Summary

OUTPUT_BUFFER_SIZE = Lib.c_stream_out_size.to_i

Constructors

Class Method Summary

Instance Method Summary

Constructor Detail

def self.new(io : ::IO, level : Int32 = LEVEL_DEFAULT, *, output_buffer : Bytes? = nil) #

output_buffer: If provided should be OUTPUT_BUFFER_SIZE bytes.


Class Method Detail

def self.open(io, level : Int32 = LEVEL_DEFAULT, *, output_buffer : Bytes? = nil, &) #

Instance Method Detail

def checksum(*args, **options) #

def checksum(*args, **options, &) #

def checksum=(arg) #

def close : Nil #
Description copied from class IO

Closes this IO.

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


def closed? : Bool #

Returns true if this writer is closed.


def level(*args, **options) #

Compression level (0..22)


def level(*args, **options, &) #

Compression level (0..22)


def level=(arg) #

Compression level (0..22)


def read(slice : Bytes) #
Description copied from class IO

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

def sync_close=(sync_close) #

Whether to close the enclosed IO when closing this writer.


def sync_close? : Bool #

Whether to close the enclosed IO when closing this writer.


def threads(*args, **options) #

def threads(*args, **options, &) #

def threads=(arg) #

def write(slice : Bytes) : Nil #
Description copied from class IO

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"