Class: Net::HTTPResponse::Inflater

Inherits:
Object
  • Object
show all
Defined in:
lib/net/http/response.rb

Overview

Inflater is a wrapper around Net::BufferedIO that transparently inflates zlib and gzip streams.

Instance Method Summary collapse

Constructor Details

#initialize(socket) ⇒ Inflater

Creates a new Inflater wrapping socket


353
354
355
356
357
# File 'lib/net/http/response.rb', line 353

def initialize socket
  @socket = socket
  # zlib with automatic gzip detection
  @inflate = Zlib::Inflate.new(32 + Zlib::MAX_WBITS)
end

Instance Method Details

#finishObject

Finishes the inflate stream.


362
363
364
365
# File 'lib/net/http/response.rb', line 362

def finish
  return if @inflate.total_in == 0
  @inflate.finish
end

#inflate_adapter(dest) ⇒ Object

Returns a Net::ReadAdapter that inflates each read chunk into dest.

This allows a large response body to be inflated without storing the entire body in memory.


373
374
375
376
377
378
379
380
381
382
383
384
385
386
# File 'lib/net/http/response.rb', line 373

def inflate_adapter(dest)
  if dest.respond_to?(:set_encoding)
    dest.set_encoding(Encoding::ASCII_8BIT)
  elsif dest.respond_to?(:force_encoding)
    dest.force_encoding(Encoding::ASCII_8BIT)
  end
  block = proc do |compressed_chunk|
    @inflate.inflate(compressed_chunk) do |chunk|
      dest << chunk
    end
  end

  Net::ReadAdapter.new(block)
end

#read(clen, dest, ignore_eof = false) ⇒ Object

Reads clen bytes from the socket, inflates them, then writes them to dest. ignore_eof is passed down to Net::BufferedIO#read

Unlike Net::BufferedIO#read, this method returns more than clen bytes. At this time there is no way for a user of Net::HTTPResponse to read a specific number of bytes from the HTTP response body, so this internal API does not return the same number of bytes as were requested.

See bugs.ruby-lang.org/issues/6492 for further discussion.


399
400
401
402
403
# File 'lib/net/http/response.rb', line 399

def read clen, dest, ignore_eof = false
  temp_dest = inflate_adapter(dest)

  @socket.read clen, temp_dest, ignore_eof
end

#read_all(dest) ⇒ Object

Reads the rest of the socket, inflates it, then writes it to dest.


408
409
410
411
412
# File 'lib/net/http/response.rb', line 408

def read_all dest
  temp_dest = inflate_adapter(dest)

  @socket.read_all temp_dest
end