File: C:/Ruby27-x64/share/doc/ruby/html/WEBrick/HTTPStatus.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module WEBrick::HTTPStatus - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="module">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-5B-5D">::[]</a>
<li ><a href="#method-c-client_error-3F">::client_error?</a>
<li ><a href="#method-c-error-3F">::error?</a>
<li ><a href="#method-c-info-3F">::info?</a>
<li ><a href="#method-c-reason_phrase">::reason_phrase</a>
<li ><a href="#method-c-redirect-3F">::redirect?</a>
<li ><a href="#method-c-server_error-3F">::server_error?</a>
<li ><a href="#method-c-success-3F">::success?</a>
<li ><a href="#method-i-client_error-3F">#client_error?</a>
<li ><a href="#method-i-error-3F">#error?</a>
<li ><a href="#method-i-info-3F">#info?</a>
<li ><a href="#method-i-reason_phrase">#reason_phrase</a>
<li ><a href="#method-i-redirect-3F">#redirect?</a>
<li ><a href="#method-i-server_error-3F">#server_error?</a>
<li ><a href="#method-i-success-3F">#success?</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-WEBrick::HTTPStatus">
<h1 id="module-WEBrick::HTTPStatus" class="module">
module WEBrick::HTTPStatus
</h1>
<section class="description">
<p>This module is used to manager HTTP status codes.</p>
<p>See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">www.w3.org/Protocols/rfc2616/rfc2616-sec10.html</a> for more information.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-5B-5D" class="method-detail ">
<div class="method-heading">
<span class="method-name">[]</span><span
class="method-args">(code)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the status class corresponding to <code>code</code></p>
<pre>WEBrick::HTTPStatus[302]
=> WEBrick::HTTPStatus::NotFound</pre>
<div class="method-source-code" id="5B-5D-source">
<pre><span class="ruby-comment"># File lib/webrick/httpstatus.rb, line 186</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">[]</span>(<span class="ruby-identifier">code</span>)
<span class="ruby-constant">CodeToError</span>[<span class="ruby-identifier">code</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-client_error-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">client_error?</span><span
class="method-args">(code)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Is <code>code</code> a client error status?</p>
<div class="method-source-code" id="client_error-3F-source">
<pre><span class="ruby-comment"># File lib/webrick/httpstatus.rb, line 170</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">client_error?</span>(<span class="ruby-identifier">code</span>)
<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">>=</span> <span class="ruby-value">400</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator"><</span> <span class="ruby-value">500</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-error-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">error?</span><span
class="method-args">(code)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Is <code>code</code> an error status?</p>
<div class="method-source-code" id="error-3F-source">
<pre><span class="ruby-comment"># File lib/webrick/httpstatus.rb, line 164</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">error?</span>(<span class="ruby-identifier">code</span>)
<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">>=</span> <span class="ruby-value">400</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator"><</span> <span class="ruby-value">600</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-info-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">info?</span><span
class="method-args">(code)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Is <code>code</code> an informational status?</p>
<div class="method-source-code" id="info-3F-source">
<pre><span class="ruby-comment"># File lib/webrick/httpstatus.rb, line 146</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">info?</span>(<span class="ruby-identifier">code</span>)
<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">>=</span> <span class="ruby-value">100</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator"><</span> <span class="ruby-value">200</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-reason_phrase" class="method-detail ">
<div class="method-heading">
<span class="method-name">reason_phrase</span><span
class="method-args">(code)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the description corresponding to the HTTP status <code>code</code></p>
<pre>WEBrick::HTTPStatus.reason_phrase 404
=> "Not Found"</pre>
<div class="method-source-code" id="reason_phrase-source">
<pre><span class="ruby-comment"># File lib/webrick/httpstatus.rb, line 140</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reason_phrase</span>(<span class="ruby-identifier">code</span>)
<span class="ruby-constant">StatusMessage</span>[<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-redirect-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">redirect?</span><span
class="method-args">(code)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Is <code>code</code> a redirection status?</p>
<div class="method-source-code" id="redirect-3F-source">
<pre><span class="ruby-comment"># File lib/webrick/httpstatus.rb, line 158</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">redirect?</span>(<span class="ruby-identifier">code</span>)
<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">>=</span> <span class="ruby-value">300</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator"><</span> <span class="ruby-value">400</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-server_error-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">server_error?</span><span
class="method-args">(code)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Is <code>code</code> a server error status?</p>
<div class="method-source-code" id="server_error-3F-source">
<pre><span class="ruby-comment"># File lib/webrick/httpstatus.rb, line 176</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">server_error?</span>(<span class="ruby-identifier">code</span>)
<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">>=</span> <span class="ruby-value">500</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator"><</span> <span class="ruby-value">600</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-success-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">success?</span><span
class="method-args">(code)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Is <code>code</code> a successful status?</p>
<div class="method-source-code" id="success-3F-source">
<pre><span class="ruby-comment"># File lib/webrick/httpstatus.rb, line 152</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">success?</span>(<span class="ruby-identifier">code</span>)
<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">>=</span> <span class="ruby-value">200</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator"><</span> <span class="ruby-value">300</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-client_error-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">client_error?</span><span
class="method-args">(code)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Is <code>code</code> a client error status?</p>
<div class="method-source-code" id="client_error-3F-source">
<pre><span class="ruby-comment"># File lib/webrick/httpstatus.rb, line 170</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">client_error?</span>(<span class="ruby-identifier">code</span>)
<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">>=</span> <span class="ruby-value">400</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator"><</span> <span class="ruby-value">500</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-error-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">error?</span><span
class="method-args">(code)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Is <code>code</code> an error status?</p>
<div class="method-source-code" id="error-3F-source">
<pre><span class="ruby-comment"># File lib/webrick/httpstatus.rb, line 164</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">error?</span>(<span class="ruby-identifier">code</span>)
<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">>=</span> <span class="ruby-value">400</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator"><</span> <span class="ruby-value">600</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-info-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">info?</span><span
class="method-args">(code)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Is <code>code</code> an informational status?</p>
<div class="method-source-code" id="info-3F-source">
<pre><span class="ruby-comment"># File lib/webrick/httpstatus.rb, line 146</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">info?</span>(<span class="ruby-identifier">code</span>)
<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">>=</span> <span class="ruby-value">100</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator"><</span> <span class="ruby-value">200</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-reason_phrase" class="method-detail ">
<div class="method-heading">
<span class="method-name">reason_phrase</span><span
class="method-args">(code)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the description corresponding to the HTTP status <code>code</code></p>
<pre>WEBrick::HTTPStatus.reason_phrase 404
=> "Not Found"</pre>
<div class="method-source-code" id="reason_phrase-source">
<pre><span class="ruby-comment"># File lib/webrick/httpstatus.rb, line 140</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reason_phrase</span>(<span class="ruby-identifier">code</span>)
<span class="ruby-constant">StatusMessage</span>[<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-redirect-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">redirect?</span><span
class="method-args">(code)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Is <code>code</code> a redirection status?</p>
<div class="method-source-code" id="redirect-3F-source">
<pre><span class="ruby-comment"># File lib/webrick/httpstatus.rb, line 158</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">redirect?</span>(<span class="ruby-identifier">code</span>)
<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">>=</span> <span class="ruby-value">300</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator"><</span> <span class="ruby-value">400</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-server_error-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">server_error?</span><span
class="method-args">(code)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Is <code>code</code> a server error status?</p>
<div class="method-source-code" id="server_error-3F-source">
<pre><span class="ruby-comment"># File lib/webrick/httpstatus.rb, line 176</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">server_error?</span>(<span class="ruby-identifier">code</span>)
<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">>=</span> <span class="ruby-value">500</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator"><</span> <span class="ruby-value">600</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-success-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">success?</span><span
class="method-args">(code)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Is <code>code</code> a successful status?</p>
<div class="method-source-code" id="success-3F-source">
<pre><span class="ruby-comment"># File lib/webrick/httpstatus.rb, line 152</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">success?</span>(<span class="ruby-identifier">code</span>)
<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">>=</span> <span class="ruby-value">200</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator"><</span> <span class="ruby-value">300</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>