class Zlib::Inflate

Overview

A read-only IO object to decompress data in zlib or gzip format.

Instances of this class wrap another IO object. When you read from this instance instance, it reads data from the underlying IO, decompresses it, and returns it to the caller.

Example: decompress text a file

string = File.open("./file.gzip", "r") do |file|
  Zlib::Inflate.gzip(file) do |inflate|
    inflate.gets_to_end
  end
end
puts string

See also: Zlib::Deflate for compressing data.

Included Modules

Defined in:

zlib/inflate.cr

Class Method Summary

Instance Method Summary

Instance methods inherited from module IO

<<(obj) : self <<, close close, closed? closed?, each_byte(&block)
each_byte each_byte, each_char(&block)
each_char each_char, each_line(*args, **options)
each_line(*args, **options, &block) each_line, encoding : String encoding, flush flush, gets(limit : Int) : String | Nil
gets(delimiter : Char, limit : Int) : String | Nil
gets(delimiter : Char) : String | Nil
gets : String | Nil
gets(delimiter : String) : String | Nil gets, gets_to_end : String gets_to_end, print(obj) : Nil
print(*objects : _) : Nil print, printf(format_string, *args) : Nil
printf(format_string, args : Array | Tuple) : Nil printf, puts(*objects : _) : Nil
puts : Nil
puts(string : String) : Nil
puts(obj) : Nil puts, read(slice : Slice(UInt8)) read, read_byte : UInt8 | Nil read_byte, read_bytes(type, format : IO::ByteFormat = IO::ByteFormat::SystemEndian) read_bytes, read_char : Char | Nil read_char, read_fully(slice : Slice(UInt8)) read_fully, read_line(*args, **options) : String | Nil read_line, read_utf8(slice : Slice(UInt8)) read_utf8, read_utf8_byte read_utf8_byte, rewind rewind, set_encoding(encoding : String, invalid : Symbol | Nil = nil) set_encoding, skip(bytes_count : Int) : Nil skip, tty? : Bool tty?, write(slice : Slice(UInt8)) : Nil write, write_byte(byte : UInt8) write_byte, write_bytes(object, format : IO::ByteFormat = IO::ByteFormat::SystemEndian) write_bytes, write_utf8(slice : Slice(UInt8)) write_utf8

Class methods inherited from module IO

copy(src, dst, limit : Int)
copy(src, dst) copy, pipe(read_blocking = false, write_blocking = false, &block)
pipe(read_blocking = false, write_blocking = false) pipe, select(read_ios, write_ios, error_ios, timeout_sec : LibC::TimeT | Int | Float | Nil)
select(read_ios, write_ios = nil, error_ios = nil) select

Instance methods inherited from module JSON::Builder

json_array(&block) json_array, json_object(&block) json_object

Instance methods inherited from class Reference

==(other)
==(other : self) ==, dup dup, hash hash, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, same?(other : Reference)
same?(other : Nil) same?, to_s(io : IO) : Nil to_s

Instance methods inherited from class Object

!=(other) !=, !~(other) !~, ==(other) ==, ===(other)
===(other : YAML::Any)
===(other : JSON::Any) ===, =~(other) =~, class class, crystal_type_id crystal_type_id, dup dup, hash hash, inspect(io : IO)
inspect inspect, itself itself, not_nil! not_nil!, tap(&block) tap, to_json to_json, to_pretty_json(indent : String = " ")
to_pretty_json(io : IO, indent : String = " ") to_pretty_json, to_s
to_s(io : IO) to_s, to_yaml
to_yaml(io : IO) to_yaml, try(&block) try

Class methods inherited from class Object

==(other : Class) ==, ===(other) ===, cast(other) : self cast, clone clone, dup dup, from_json(string_or_io) : self
from_json(string_or_io, root : String) : self from_json, from_yaml(string : String) : self from_yaml, hash hash, inspect(io) inspect, name : String name, nilable? nilable?, to_s(io) to_s, |(other : U.class) forall U |

Class Method Detail

def self.gzip(input, sync_close : Bool = false) : self #

Creates an instance of Zlib::Inflate for the gzip format. has written.


[View source]
def self.gzip(input, sync_close : Bool = false, &block) #

Creates an instance of Zlib::Inflate for the gzip format, yields it to the given block, and closes it at its end.


[View source]
def self.new(input : IO, wbits = LibZ::MAX_BITS, sync_close : Bool = false) #

Creates an instance of Zlib::Inflate.


[View source]
def self.new(input : IO, wbits = LibZ::MAX_BITS, sync_close : Bool = false, &block) #

Creates an instance of Zlib::Inflate, yields it to the given block, and closes it at its end.


[View source]

Instance Method Detail

def close #

Closes this IO.


[View source]
def closed? : Bool #

Returns true if this IO is closed.


[View source]
def read(slice : Slice(UInt8)) #

See IO#read.


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

If sync_close is true, closing this IO will close the underlying IO.


[View source]
def sync_close? : Bool #

If sync_close is true, closing this IO will close the underlying IO.


[View source]
def write(slice : Slice(UInt8)) #

Always raises: this is a read-only IO.


[View source]