arachnid/docs/Arachnid/Resource/StatusCodes.html

494 lines
14 KiB
HTML
Raw Normal View History

2019-06-27 03:25:07 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.29.0">
<link href="../../css/style.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="../../js/doc.js"></script>
<script type="text/javascript">
CrystalDoc.base_path = "../../";
</script>
<meta id="repository-name" content="github.com/watzon/arachnid">
<title>Arachnid::Resource::StatusCodes - github.com/watzon/arachnid</title>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
</div>
<div class="repository-links">
<a href="../../index.html">README</a>
</div>
</div>
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
<div class="types-list">
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid" data-name="arachnid">
<a href="../../Arachnid.html">Arachnid</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent" data-name="arachnid::agent">
<a href="../../Arachnid/Agent.html">Agent</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions" data-name="arachnid::agent::actions">
<a href="../../Arachnid/Agent/Actions.html">Actions</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Action" data-name="arachnid::agent::actions::action">
<a href="../../Arachnid/Agent/Actions/Action.html">Action</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Paused" data-name="arachnid::agent::actions::paused">
<a href="../../Arachnid/Agent/Actions/Paused.html">Paused</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/RuntimeError" data-name="arachnid::agent::actions::runtimeerror">
<a href="../../Arachnid/Agent/Actions/RuntimeError.html">RuntimeError</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipLink" data-name="arachnid::agent::actions::skiplink">
<a href="../../Arachnid/Agent/Actions/SkipLink.html">SkipLink</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipResource" data-name="arachnid::agent::actions::skipresource">
<a href="../../Arachnid/Agent/Actions/SkipResource.html">SkipResource</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Queue" data-name="arachnid::agent::queue">
<a href="../../Arachnid/Agent/Queue.html">Queue</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthCredential" data-name="arachnid::authcredential">
<a href="../../Arachnid/AuthCredential.html">AuthCredential</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthStore" data-name="arachnid::authstore">
<a href="../../Arachnid/AuthStore.html">AuthStore</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/CookieJar" data-name="arachnid::cookiejar">
<a href="../../Arachnid/CookieJar.html">CookieJar</a>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document" data-name="arachnid::document">
<a href="../../Arachnid/Document.html">Document</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML" data-name="arachnid::document::html">
<a href="../../Arachnid/Document/HTML.html">HTML</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML/Tag" data-name="arachnid::document::html::tag">
<a href="../../Arachnid/Document/HTML/Tag.html">Tag</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid/Resource" data-name="arachnid::resource">
<a href="../../Arachnid/Resource.html">Resource</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/ContentTypes" data-name="arachnid::resource::contenttypes">
<a href="../../Arachnid/Resource/ContentTypes.html">ContentTypes</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/Cookies" data-name="arachnid::resource::cookies">
<a href="../../Arachnid/Resource/Cookies.html">Cookies</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/HTML" data-name="arachnid::resource::html">
<a href="../../Arachnid/Resource/HTML.html">HTML</a>
</li>
<li class=" current" data-id="github.com/watzon/arachnid/Arachnid/Resource/StatusCodes" data-name="arachnid::resource::statuscodes">
<a href="../../Arachnid/Resource/StatusCodes.html">StatusCodes</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Rules" data-name="arachnid::rules(t)">
<a href="../../Arachnid/Rules.html">Rules</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/SessionCache" data-name="arachnid::sessioncache">
<a href="../../Arachnid/SessionCache.html">SessionCache</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/URI" data-name="uri">
<a href="../../URI.html">URI</a>
</li>
</ul>
</div>
</div>
<div class="main-content">
<h1 class="type-name">
<span class="kind">module</span> Arachnid::Resource::StatusCodes
</h1>
<h2>Direct including types</h2>
<ul class="other-types-list">
<li class="other-type"><a href="../../Arachnid/Resource.html">Arachnid::Resource</a></li>
</ul>
<h2>Defined in:</h2>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/status_codes.cr#L3" target="_blank">
arachnid/resource/status_codes.cr
</a>
<br/>
<h2>Instance Method Summary</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#bad_request%3F-instance-method" class="signature"><strong>#bad_request?</strong></a>
<div class="summary"><p>Determines if the response code is <code>400</code>.</p></div>
</li>
<li class="entry-summary">
<a href="#code-instance-method" class="signature"><strong>#code</strong></a>
<div class="summary"><p>The response code from the resource.</p></div>
</li>
<li class="entry-summary">
<a href="#forbidden%3F-instance-method" class="signature"><strong>#forbidden?</strong></a>
<div class="summary"><p>Determines if the response code is <code>403</code>.</p></div>
</li>
<li class="entry-summary">
<a href="#had_internal_server_error%3F-instance-method" class="signature"><strong>#had_internal_server_error?</strong></a>
<div class="summary"><p>Determines if the response code is <code>500</code>.</p></div>
</li>
<li class="entry-summary">
<a href="#missing%3F-instance-method" class="signature"><strong>#missing?</strong></a>
<div class="summary"><p>Determines if the response code is <code>404</code>.</p></div>
</li>
<li class="entry-summary">
<a href="#ok%3F-instance-method" class="signature"><strong>#ok?</strong></a>
<div class="summary"><p>Determines if the response code is <code>200</code>.</p></div>
</li>
<li class="entry-summary">
<a href="#redirect%3F-instance-method" class="signature"><strong>#redirect?</strong></a>
<div class="summary"><p>Determines if the response code is <code>300</code>, <code>301</code>, <code>302</code>, <code>303</code> or <code>307</code>.</p></div>
</li>
<li class="entry-summary">
<a href="#timedout%3F-instance-method" class="signature"><strong>#timedout?</strong></a>
<div class="summary"><p>Determines if the response code is <code>308</code>.</p></div>
</li>
<li class="entry-summary">
<a href="#unauthorized%3F-instance-method" class="signature"><strong>#unauthorized?</strong></a>
<div class="summary"><p>Determines if the response code is <code>401</code>.</p></div>
</li>
</ul>
<div class="methods-inherited">
</div>
<h2>Instance Method Detail</h2>
<div class="entry-detail" id="bad_request?-instance-method">
<div class="signature">
def <strong>bad_request?</strong>
<a class="method-permalink" href="#bad_request%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the response code is <code>400</code>.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/status_codes.cr#L20" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="code-instance-method">
<div class="signature">
def <strong>code</strong>
<a class="method-permalink" href="#code-instance-method">#</a>
</div>
<div class="doc"><p>The response code from the resource.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/status_codes.cr#L5" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="forbidden?-instance-method">
<div class="signature">
def <strong>forbidden?</strong>
<a class="method-permalink" href="#forbidden%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the response code is <code>403</code>.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/status_codes.cr#L30" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="had_internal_server_error?-instance-method">
<div class="signature">
def <strong>had_internal_server_error?</strong>
<a class="method-permalink" href="#had_internal_server_error%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the response code is <code>500</code>.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/status_codes.cr#L40" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="missing?-instance-method">
<div class="signature">
def <strong>missing?</strong>
<a class="method-permalink" href="#missing%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the response code is <code>404</code>.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/status_codes.cr#L35" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="ok?-instance-method">
<div class="signature">
def <strong>ok?</strong>
<a class="method-permalink" href="#ok%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the response code is <code>200</code>.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/status_codes.cr#L10" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="redirect?-instance-method">
<div class="signature">
def <strong>redirect?</strong>
<a class="method-permalink" href="#redirect%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the response code is <code>300</code>, <code>301</code>, <code>302</code>, <code>303</code>
or <code>307</code>. Also checks for "soft" redirects added at the resource
level by a meta refresh tag.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/status_codes.cr#L47" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="timedout?-instance-method">
<div class="signature">
def <strong>timedout?</strong>
<a class="method-permalink" href="#timedout%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the response code is <code>308</code>.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/status_codes.cr#L15" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="unauthorized?-instance-method">
<div class="signature">
def <strong>unauthorized?</strong>
<a class="method-permalink" href="#unauthorized%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the response code is <code>401</code>.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/status_codes.cr#L25" target="_blank">View source</a>]
</div>
</div>
</div>
</body>
</html>