class HTTP::Response::Body

A streamable response body, also easily converted into a string

def each

Iterate over the body, allowing it to be enumerable
def each
  while (chunk = readpartial)
    yield chunk
  end
end

def initialize(client, encoding = Encoding::BINARY)

def initialize(client, encoding = Encoding::BINARY)
  @client    = client
  @streaming = nil
  @contents  = nil
  @encoding  = encoding
end

def inspect

Easier to interpret string inspect
def inspect
  "#<#{self.class}:#{object_id.to_s(16)} @streaming=#{!!@streaming}>"
end

def readpartial(*args)

(see HTTP::Client#readpartial)
def readpartial(*args)
  stream!
  @client.readpartial(*args)
end

def stream!

Assert that the body is actively being streamed
def stream!
  raise StateError, "body has already been consumed" if @streaming == false
  @streaming = true
end

def to_s

Returns:
  • (String) - eagerly consume the entire body as a string
def to_s
  return @contents if @contents
  raise StateError, "body is being streamed" unless @streaming.nil?
  # see issue 312
  begin
    encoding = Encoding.find @encoding
  rescue ArgumentError
    encoding = Encoding::BINARY
  end
  begin
    @streaming = false
    @contents = "".force_encoding(encoding)
    while (chunk = @client.readpartial)
      @contents << chunk.force_encoding(encoding)
    end
  rescue
    @contents = nil
    raise
  end
  @contents
end