Ruby 2.3.0 リファレンスマニュアル > ライブラリ一覧 > webrick/httpstatusライブラリ > WEBrick::HTTPStatusモジュール

module WEBrick::HTTPStatus

クラスの継承リスト: WEBrick::HTTPStatus

要約

HTTP のステータスを表す例外クラスを提供するモジュールです。 ステータスコード 200 などの成功の場合も含まれます。

以下のような継承による階層を構成しています。

StandardError
 * WEBrick::HTTPStatus::Status
    * WEBrick::HTTPStatus::Info             (1XX)
    * WEBrick::HTTPStatus::Success          (2XX)
    * WEBrick::HTTPStatus::Redirect         (3XX)
    * WEBrick::HTTPStatus::Error
       * WEBrick::HTTPStatus::ClientError   (4XX)
       * WEBrick::HTTPStatus::ServerError   (5XX)

目次

特異メソッド

[]

モジュール関数

client_error? error? info? reason_phrase redirect? server_error? success?

定数

RC_ACCEPTED RC_BAD_GATEWAY RC_BAD_REQUEST RC_CONFLICT RC_CONTINUE RC_CREATED RC_EXPECTATION_FAILED RC_FORBIDDEN RC_FOUND RC_GATEWAY_TIMEOUT RC_GONE RC_HTTP_VERSION_NOT_SUPPORTED RC_INTERNAL_SERVER_ERROR RC_LENGTH_REQUIRED RC_METHOD_NOT_ALLOWED RC_MOVED_PERMANENTLY RC_MULTIPLE_CHOICES RC_NON_AUTHORITATIVE_INFORMATION RC_NOT_ACCEPTABLE RC_NOT_FOUND RC_NOT_IMPLEMENTED RC_NOT_MODIFIED RC_NO_CONTENT RC_OK RC_PARTIAL_CONTENT RC_PAYMENT_REQUIRED RC_PRECONDITION_FAILED RC_PROXY_AUTHENTICATION_REQUIRED RC_REQUEST_ENTITY_TOO_LARGE RC_REQUEST_RANGE_NOT_SATISFIABLE RC_REQUEST_TIMEOUT RC_REQUEST_URI_TOO_LARGE RC_RESET_CONTENT RC_SEE_OTHER RC_SERVICE_UNAVAILABLE RC_SWITCHING_PROTOCOLS RC_TEMPORARY_REDIRECT RC_UNAUTHORIZED RC_UNSUPPORTED_MEDIA_TYPE RC_USE_PROXY

特異メソッド

self[code] -> Class[permalink][rdoc]

指定された整数が表すステータスコードに対応する WEBrick::HTTPStatus::Status のサブクラスを返します。

[PARAM] code:

HTTP のステータスコードを表す整数を指定します。

require 'webrick'
p WEBrick::HTTPStatus[200]   #=> WEBrick::HTTPStatus::OK

モジュール関数

client_error?(code) -> bool[permalink][rdoc]

指定された整数が表すステータスコードが 4XX である場合に true を返します。そうでない場合に false を返します。

[PARAM] code:

HTTP のステータスコードを表す整数か文字列を指定します。

error?(code) -> bool[permalink][rdoc]

指定された整数が表すステータスコードが 4XX, 5xx である場合に true を返します。そうでない場合に false を返します。

[PARAM] code:

HTTP のステータスコードを表す整数か文字列を指定します。

info?(code) -> bool[permalink][rdoc]

指定された整数が表すステータスコードが 1XX である場合に true を返します。そうでない場合に false を返します。

[PARAM] code:

HTTP のステータスコードを表す整数を指定します。

reason_phrase(code) -> String[permalink][rdoc]

指定された整数が表すステータスコードに対応する reason phrase を表す文字列を返します。

[PARAM] code:

HTTP のステータスコードを表す整数か文字列を指定します。

require 'webrick'
p WEBrick::HTTPStatus.reason_phrase(304)   #=> "Not Modified"

redirect?(code) -> bool[permalink][rdoc]

指定された整数が表すステータスコードが 3XX である場合に true を返します。そうでない場合に false を返します。

[PARAM] code:

HTTP のステータスコードを表す整数か文字列を指定します。

server_error?(code) -> bool[permalink][rdoc]

指定された整数が表すステータスコードが 5XX である場合に true を返します。そうでない場合に false を返します。

[PARAM] code:

HTTP のステータスコードを表す整数か文字列を指定します。

success?(code) -> bool[permalink][rdoc]

指定された整数が表すステータスコードが 2XX である場合に true を返します。そうでない場合に false を返します。

[PARAM] code:

HTTP のステータスコードを表す整数か文字列を指定します。

定数

RC_CONTINUE[permalink][rdoc]

RC_SWITCHING_PROTOCOLS

RC_OK

RC_CREATED

RC_ACCEPTED

RC_NON_AUTHORITATIVE_INFORMATION

RC_NO_CONTENT

RC_RESET_CONTENT

RC_PARTIAL_CONTENT

RC_MULTIPLE_CHOICES

RC_MOVED_PERMANENTLY

RC_FOUND

RC_SEE_OTHER

RC_NOT_MODIFIED

RC_USE_PROXY

RC_TEMPORARY_REDIRECT

RC_BAD_REQUEST

RC_UNAUTHORIZED

RC_PAYMENT_REQUIRED

RC_FORBIDDEN

RC_NOT_FOUND

RC_METHOD_NOT_ALLOWED

RC_NOT_ACCEPTABLE

RC_PROXY_AUTHENTICATION_REQUIRED

RC_REQUEST_TIMEOUT

RC_CONFLICT

RC_GONE

RC_LENGTH_REQUIRED

RC_PRECONDITION_FAILED

RC_REQUEST_ENTITY_TOO_LARGE

RC_REQUEST_URI_TOO_LARGE

RC_UNSUPPORTED_MEDIA_TYPE

RC_REQUEST_RANGE_NOT_SATISFIABLE

RC_EXPECTATION_FAILED

RC_INTERNAL_SERVER_ERROR

RC_NOT_IMPLEMENTED

RC_BAD_GATEWAY

RC_SERVICE_UNAVAILABLE

RC_GATEWAY_TIMEOUT

RC_HTTP_VERSION_NOT_SUPPORTED

HTTP のステータスコードを表す整数です。

require 'webrick'
p WEBrick::HTTPStatus::RC_INTERNAL_SERVER_ERROR   #=> 500