In Files

  • net/http/response.rb
  • net/http/responses.rb

Class/Module Index [+]



frozen_string_literal: false HTTP response class.

This class wraps together the response header and the response body (the entity requested).

It mixes in the HTTPHeader module, which provides access to response header values both via hash-like methods and via individual readers.

Note that each possible HTTP response code defines its own HTTPResponse subclass. These are listed below.

All classes are defined under the Net module. Indentation indicates inheritance. For a list of the classes see Net::HTTP.



The HTTP result code string. For example, ‘302’. You can also determine the response type by examining which response subclass the response object is an instance of.


Set to true automatically when the request did not contain an Accept-Encoding header from the user.


The HTTP version supported by the server.


The HTTP result message sent by the server. For example, ‘Not Found’.


The HTTP result message sent by the server. For example, ‘Not Found’.


The URI used to fetch this response. The response URI is only available if a URI was used to create the request.

Public Class Methods

body_permitted?() click to toggle source

true if the response has a body.

               # File net/http/response.rb, line 20
def body_permitted?

Public Instance Methods

body() click to toggle source

Returns the full entity body.

Calling this method a second or subsequent time will return the string already read.

http.request_get('/index.html') {|res|
  puts res.body

http.request_get('/index.html') {|res|
  p res.body.object_id   # 538149362
  p res.body.object_id   # 538149362
               # File net/http/response.rb, line 226
def body
Also aliased as: entity
body=(value) click to toggle source

Because it may be necessary to modify the body, Eg, decompression this method facilitates that.

               # File net/http/response.rb, line 232
def body=(value)
  @body = value
entity() click to toggle source
Alias for: body
inspect() click to toggle source
               # File net/http/response.rb, line 107
def inspect
  "#<#{self.class} #{@code} #{@message} readbody=#{@read}>"
read_body(dest = nil, &block) click to toggle source

Gets the entity body returned by the remote HTTP server.

If a block is given, the body is passed to the block, and the body is provided in fragments, as it is read in from the socket.

Calling this method a second or subsequent time for the same HTTPResponse object will return the value already read.

http.request_get('/index.html') {|res|
  puts res.read_body

http.request_get('/index.html') {|res|
  p res.read_body.object_id   # 538149362
  p res.read_body.object_id   # 538149362

# using iterator
http.request_get('/index.html') {|res|
  res.read_body do |segment|
    print segment
               # File net/http/response.rb, line 194
def read_body(dest = nil, &block)
  if @read
    raise IOError, "#{self.class}\#read_body called twice" if dest or block
    return @body
  to = procdest(dest, block)
  if @body_exist
    read_body_0 to
    @body = to
    @body = nil
  @read = true

value() click to toggle source

Raises an HTTP error if the response is not 2xx (success).

               # File net/http/response.rb, line 128
def value
  error! unless self.kind_of?(Net::HTTPSuccess)

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit