Flate::Reader
class Flate::Reader
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
Defined in:
flate/reader.crClass Method Summary
- .gzip(input, sync_close : Bool = false) : self
Creates an instance of Flate::Reader for the gzip format.
- .gzip(input, sync_close : Bool = false, &block)
Creates an instance of Flate::Reader for the gzip format, yields it to the given block, and closes it at its end.
- .new(io : IO, sync_close : Bool = false, dict : Bytes? = nil)
Creates an instance of Flate::Reader.
- .new(input : IO, sync_close : Bool = false, dict : Bytes? = nil, &block)
Creates an instance of Flate::Reader, yields it to the given block, and closes it at its end.
Instance Method Summary
- #close
Closes this reader.
- #closed? : Bool
Returns
trueif this reader is closed. - #read(slice : Bytes)
See
IO#read. - #sync_close=(sync_close : Bool)
If
#sync_close?istrue, closing this IO will close the underlying IO. - #sync_close? : Bool
If
#sync_close?istrue, closing this IO will close the underlying IO. - #write(slice : Bytes)
Instance methods inherited from module IO
< <<, close close, closed? closed?, each_byteeach_byte(&block) : Nil each_byte, each_char(&block) : Nil
each_char each_char, each_line(*args, **options, &block) : Nil
each_line(*args, **options) each_line, encoding : String encoding, flush flush, gets(limit : Int, chomp = false) : String?
gets(delimiter : Char, chomp = false) : String?
gets(delimiter : String, chomp = false) : String?
gets(chomp = true) : String?
gets(delimiter : Char, limit : Int, chomp = false) : String? gets, gets_to_end : String gets_to_end, peek : Bytes? peek, print(*objects : _) : Nil
print(obj) : Nil print, printf(format_string, args : Array | Tuple) : Nil
printf(format_string, *args) : Nil printf, puts(*objects : _) : Nil
puts : Nil
puts(obj) : Nil
puts(string : String) : Nil puts, read(slice : Bytes) read, read_byte : UInt8? read_byte, read_bytes(type, format : IO::ByteFormat = IO::ByteFormat::SystemEndian) read_bytes, read_char : Char? read_char, read_fully(slice : Bytes) read_fully, read_fully?(slice : Bytes) read_fully?, read_line(*args, **options) : String? read_line, read_string(bytesize : Int) : String read_string, read_utf8(slice : Bytes) read_utf8, read_utf8_byte read_utf8_byte, rewind rewind, set_encoding(encoding : String, invalid : Symbol? = nil) set_encoding, skip(bytes_count : Int) : Nil skip, skip_to_end : Nil skip_to_end, tty? : Bool tty?, write(slice : Bytes) : Nil write, write_byte(byte : UInt8) write_byte, write_bytes(object, format : IO::ByteFormat = IO::ByteFormat::SystemEndian) write_bytes, write_utf8(slice : Bytes) write_utf8
Class methods inherited from module IO
copy(src, dst, limit : Int)copy(src, dst) copy, pipe(read_blocking = false, write_blocking = false)
pipe(read_blocking = false, write_blocking = false, &block) pipe, select(read_ios, write_ios, error_ios, timeout_sec : LibC::TimeT | Int | Float?)
select(read_ios, write_ios = nil, error_ios = nil) select
Instance methods inherited from class Reference
==(other : self)==(other) ==, dup dup, hash hash, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, pretty_print(pp) : Nil pretty_print, same?(other : Reference)
same?(other : Nil) same?, to_s(io : IO) : Nil to_s
Class methods inherited from class Reference
new new Instance methods inherited from class Object
!=(other) !=, !~(other) !~, ==(other) ==, ===(other : JSON::Any)===(other : YAML::Any)
===(other) ===, =~(other) =~, class class, dup dup, hash hash, inspect(io : IO)
inspect inspect, itself itself, not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, tap(&block) tap, to_json(io : IO)
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(io : IO)
to_yaml to_yaml, try(&block) try
Class methods inherited from class Object
from_json(string_or_io, root : String) : selffrom_json(string_or_io) : self from_json, from_yaml(string_or_io) : self from_yaml
Class Method Detail
def self.gzip(input, sync_close : Bool = false) : selfSource
Creates an instance of Flate::Reader for the gzip format. has written.
def self.gzip(input, sync_close : Bool = false, &block)Source
Creates an instance of Flate::Reader for the gzip format, yields it to the given block, and closes it at its end.
def self.new(io : IO, sync_close : Bool = false, dict : Bytes? = nil)Source
Creates an instance of Flate::Reader.
def self.new(input : IO, sync_close : Bool = false, dict : Bytes? = nil, &block)Source
Creates an instance of Flate::Reader, yields it to the given block, and closes it at its end.
Instance Method Detail
def closeSource
Closes this reader.
def sync_close=(sync_close : Bool)Source
If #sync_close? is true, closing this IO will close the underlying IO.
def sync_close? : BoolSource
If #sync_close? is true, closing this IO will close the underlying IO.
© 2012–2017 Manas Technology Solutions.
Licensed under the Apache License, Version 2.0.
https://crystal-lang.org/api/0.22.0/Flate/Reader.html
