class Net::HTTPResponse (Ruby 2.0.0 リファレンスマニュアル)

このマニュアルは既にメンテナンスが終了したバージョンの Ruby を対象としています。最新版のマニュアルへ

要約

HTTP レスポンスを表現するクラスです。 Net::HTTP クラスは実際には HTTPResponse のサブクラスを返します。

Net::HTTPHeaderから継承しているメソッド

body_permitted? -> bool[permalink][rdoc]: エンティティボディを含むことが許されているレスポンスクラスならば真を、そうでなければ偽を返します。

body -> String | () | nil[permalink][rdoc]

entity -> String | () | nil

エンティティボディを返します。

レスポンスにボディがない場合には nil を返します。

Net::HTTPResponse#read_body をブロック付きで呼んだ場合にはこのメソッドはNet::ReadAdapter のインスタンスを返しますが、これは使わないでください。

entity は obsolete です。

code -> String[permalink][rdoc]

HTTP のリザルトコードです。例えば '302' などです。

この値を見ることでレスポンスの種類を判別できますが、レスポンスオブジェクトがどのクラスのインスタンスかを見ることでもレスポンスの種類を判別できます。

response -> self[permalink][rdoc]

header -> self

reader_header -> self

互換性を保つためだけに導入されたメソッドです。使わないでください。

自分自身を返します。

http_version -> String[permalink][rdoc]

サーバがサポートしている HTTP のバージョンを文字列で返します。

message -> String[permalink][rdoc]

msg -> String

HTTP サーバがリザルトコードに付加して返すメッセージです。例えば 'Not Found' などです。

msg は obsolete です。使わないでください。

read_body(dest=nil) -> String|nil[permalink][rdoc]

read_body {|str| .... } -> ()

ブロックを与えなかった場合にはエンティティボディを文字列で返します。ブロックを与えた場合にはエンティティボディを少しずつ取得して順次ブロックに文字列で与えます。

レスポンスがボディを持たない場合には nil を返します。

一度ブロックを与えずにこのメソッドを呼んだ場合には、次からはすでに読みだしたボディを文字列として返します。また一度ブロックを与えてこのメソッドを呼んだ場合には、次からは Net::ReadAdapter のインスタンスが返ってきますが、その場合はそのオブジェクトは使わないでください。

dest は obsolete です。使わないでください。 dest を指定した場合にはボディを少しずつ取得して順次「dest << ボディの断片」を実行します。

to_ary -> [Net::HTTPResponse, String][permalink][rdoc]

このメソッドは net/http.rb 1.1 との互換性のために存在します。

[self, self.body] を返します。

value -> nil[permalink][rdoc]

レスポンスが 2xx(成功)でなかった場合に、対応する例外を発生させます。