# class Compress::Deflate::Reader

- Compress::Deflate::Reader
- IO
- Reference
- Object

##
Overview

A read-only `IO` object to decompress data in the DEFLATE 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.

##
Included Modules

- IO::Buffered

##
Defined in:

compress/deflate/reader.cr

##
Constructors

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

  Creates an instance of Flate::Reader for the gzip format.

- .new(io : IO, sync_close : Bool = false, dict : Bytes | Nil = nil)

  Creates an instance of Flate::Reader.

##
Class Method Summary

- .gzip(input, sync_close : Bool = false, &)

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

- .open(io : IO, sync_close : Bool = false, dict : Bytes | Nil = nil, &)

  Creates a new reader from the given io, yields it to the given block, and closes it at its end.

##
Instance Method Summary

- #closed? : Bool

  Returns `true` if this reader is closed.

- #dict : Bytes | Nil

  Dictionary passed in the constructor

- #inspect(io : IO) : Nil

  Appends a String representation of this object which includes its class name, its object address and the values of all instance variables.

- #sync_close=(sync_close : Bool)

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

- #sync_close? : Bool

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

- #unbuffered_close : Nil

  Closes this reader.

- #unbuffered_flush : NoReturn

  Flushes the wrapped `IO`.

- #unbuffered_read(slice : Bytes) : Int32

  See `IO#read`.

- #unbuffered_rewind : Nil

  Rewinds the wrapped `IO`.

- #unbuffered_write(slice : Bytes) : NoReturn

  Always raises `IO::Error` because this is a read-only `IO`.

### Instance methods inherited from module `IO::Buffered`

buffer_size : Int32 buffer_size, buffer_size=(value) buffer_size=, close : Nil close, flush : self flush, flush_on_newline=(flush_on_newline : Bool) : Bool flush_on_newline=, flush_on_newline? : Bool flush_on_newline?, peek : Bytes peek, pos : Int64 pos, read(slice : Bytes) : Int32 read, read_buffering=(read_buffering : Bool) : Bool read_buffering=, read_buffering? : Bool read_buffering?, rewind : self rewind, sync=(sync : Bool) : Bool sync=, sync? : Bool sync?, unbuffered_close unbuffered_close, unbuffered_flush unbuffered_flush, unbuffered_read(slice : Bytes) unbuffered_read, unbuffered_rewind unbuffered_rewind, unbuffered_write(slice : Bytes) unbuffered_write, write(slice : Bytes) : Nil write

### Instance methods inherited from class `IO`

<<(obj : _) : self <<, close close, closed? : Bool closed?, each_byte(&) : Nil
each_byte each_byte, each_char(&) : Nil
each_char each_char, each_line(*args, **options, &block : String -> ) : Nil
each_line(*args, **options) each_line, encoding : String encoding, flush flush, getb_to_end : Bytes getb_to_end, gets(delimiter : Char, limit : Int, chomp = false) : String | Nil
gets(chomp : Bool = true) : String | Nil
gets(limit : Int, chomp : Bool = false) : String | Nil
gets(delimiter : Char, chomp : Bool = false) : String | Nil
gets(delimiter : String, chomp = false) : String | Nil gets, gets_to_end : String gets_to_end, peek : Bytes | Nil peek, pos pos, pos=(value) pos=, print(obj : _) : Nil
print(*objects : _) : Nil print, printf(format_string : String, args : Array | Tuple) : Nil
printf(format_string : String, *args) : Nil printf, puts(string : String) : Nil
puts(obj : _) : Nil
puts : Nil
puts(*objects : _) : Nil puts, read(slice : Bytes) read, read_at(offset, bytesize, & : IO -> ) read_at, 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 : Bytes) : Int32 read_fully, read_fully?(slice : Bytes) : Int32 | Nil read_fully?, read_greedy(slice : Bytes) : Int32 read_greedy, read_line(*args, **options) : String read_line, read_string(bytesize : Int) : String read_string, read_utf8(slice : Bytes) : Int32 read_utf8, read_utf8_byte : UInt8 | Nil read_utf8_byte, rewind rewind, seek(offset, whence : Seek = Seek::Set) seek, set_encoding(encoding : String, invalid : Symbol | Nil = nil) : Nil set_encoding, skip(bytes_count : Int) : Nil skip, skip_to_end : Nil skip_to_end, tell tell, tty? : Bool tty?, write(slice : Bytes) : Nil write, write_byte(byte : UInt8) : Nil write_byte, write_bytes(object : _, format : IO::ByteFormat = IO::ByteFormat::SystemEndian) : Nil write_bytes, write_string(slice : Bytes) : Nil write_string, write_utf8(slice : Bytes) : Nil write_utf8

### Class methods inherited from class `IO`

copy(src : IO, dst : IO, limit : Int) : Int64
copy(src : IO, dst : IO) : Int64 copy, pipe(read_blocking : Bool | Nil = nil, write_blocking : Bool | Nil = nil) : Tuple(IO::FileDescriptor, IO::FileDescriptor)
pipe(read_blocking = nil, write_blocking = nil, &) pipe, same_content?(stream1 : IO, stream2 : IO) : Bool same_content?

### Instance methods inherited from class `Reference`

==(other : self)
==(other : JSON::Any)
==(other : YAML::Any)
==(other) ==, dup dup, hash(hasher) hash, initialize initialize, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, pretty_print(pp) : Nil pretty_print, same?(other : Reference) : Bool
same?(other : Nil) same?, to_s(io : IO) : Nil to_s

### Constructor methods inherited from class `Reference`

new new, unsafe_construct(address : Pointer, *args, **opts) : self unsafe_construct

### Class methods inherited from class `Reference`

pre_initialize(address : Pointer) pre_initialize

### Instance methods inherited from class `Object`

! : Bool !, !=(other) !=, !~(other) !~, ==(other) ==, ===(other : JSON::Any)
===(other : YAML::Any)
===(other) ===, =~(other) =~, as(type : Class) as, as?(type : Class) as?, class class, dup dup, hash(hasher)
hash hash, in?(collection : Object) : Bool
in?(*values : Object) : Bool in?, inspect(io : IO) : Nil
inspect : String inspect, is_a?(type : Class) : Bool is_a?, itself itself, nil? : Bool nil?, not_nil!(message)
not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, responds_to?(name : Symbol) : Bool responds_to?, tap(&) tap, to_json(io : IO) : Nil
to_json : String to_json, to_pretty_json(indent : String = " ") : String
to_pretty_json(io : IO, indent : String = " ") : Nil to_pretty_json, to_s(io : IO) : Nil
to_s : String to_s, to_yaml(io : IO) : Nil
to_yaml : String to_yaml, try(&) try, unsafe_as(type : T.class) forall T unsafe_as

### Class methods inherited from class `Object`

from_json(string_or_io : String | IO, root : String)
from_json(string_or_io : String | IO) from_json, from_yaml(string_or_io : String | IO) from_yaml

### Macros inherited from class `Object`

class_getter(*names, &block) class_getter, class_getter!(*names) class_getter!, class_getter?(*names, &block) class_getter?, class_property(*names, &block) class_property, class_property!(*names) class_property!, class_property?(*names, &block) class_property?, class_setter(*names) class_setter, def_clone def_clone, def_equals(*fields) def_equals, def_equals_and_hash(*fields) def_equals_and_hash, def_hash(*fields) def_hash, delegate(*methods, to object) delegate, forward_missing_to(delegate) forward_missing_to, getter(*names, &block) getter, getter!(*names) getter!, getter?(*names, &block) getter?, property(*names, &block) property, property!(*names) property!, property?(*names, &block) property?, setter(*names) setter

##
Constructor Detail

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

Creates an instance of Flate::Reader for the gzip format. has written.

def self.new(io : IO, sync_close : Bool = false, dict : Bytes | Nil = nil) #

Creates an instance of Flate::Reader.

##
Class Method Detail

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

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

def self.open(io : IO, sync_close : Bool = false, dict : Bytes | Nil = nil, &) #

Creates a new reader from the given io, yields it to the given block, and closes it at its end.

##
Instance Method Detail

def closed? : Bool #

Returns `true` if this reader is closed.

def dict : Bytes | Nil #

Dictionary passed in the constructor

def inspect(io : IO) : Nil #
Description copied from class Reference

Appends a String representation of this object which includes its class name, its object address and the values of all instance variables.

    class Person
      def initialize(@name : String, @age : Int32)
      end
    end

    Person.new("John", 32).inspect # => #<Person:0x10fd31f20 @name="John", @age=32>

def sync_close=(sync_close : Bool) #

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

def sync_close? : Bool #

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

def unbuffered_close : Nil #

Closes this reader.

def unbuffered_flush : NoReturn #
Description copied from module IO::Buffered

Flushes the wrapped `IO`.

TODO Add return type restriction `Nil`

def unbuffered_read(slice : Bytes) : Int32 #

See `IO#read`.

def unbuffered_rewind : Nil #
Description copied from module IO::Buffered

Rewinds the wrapped `IO`.

TODO Add return type restriction `Nil`

def unbuffered_write(slice : Bytes) : NoReturn #

Always raises `IO::Error` because this is a read-only `IO`.