class Compress::LZ4::IO

Defined in:

lz4/io.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(io : ::IO, compress_options = CompressOptions.new, sync_close : Bool = false) #

[View source]

Instance Method Detail

def close #

Ends the current LZ4 frame, the stream can still be written to, unless @sync_close


[View source]
def closed? : Bool #
Description copied from class IO

Returns true if this IO is closed.

IO defines returns false, but including types may override.


[View source]
def compressed_bytes_in : UInt64 #

[View source]
def compressed_bytes_out : UInt64 #

[View source]
def finalize #

[View source]
def flush : Nil #

Flush LZ4 lib buffers even if a block isn't full


[View source]
def local_address : Socket::Address #

def local_address=(local_address : Socket::Address) #

[View source]
def local_address? : Socket::Address | Nil #

def read(slice : Bytes) : Int32 #
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

[View source]
def remote_address : Socket::Address #

def remote_address=(remote_address : Socket::Address) #

[View source]
def remote_address? : Socket::Address | Nil #

def rewind #
Description copied from class IO

Rewinds this IO. By default this method raises, but including types may implement it.


[View source]
def sync_close=(sync_close : Bool) #

[View source]
def sync_close? : Bool #

[View source]
def uncompressed_bytes_in : UInt64 #

[View source]
def uncompressed_bytes_out : UInt64 #

[View source]
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"

[View source]