Server : LiteSpeed System : Linux premium163.web-hosting.com 4.18.0-513.18.1.lve.el8.x86_64 #1 SMP Thu Feb 22 12:55:50 UTC 2024 x86_64 User : infihsqw ( 644) PHP Version : 8.1.29 Disable Function : NONE Directory : /opt/cpanel/ea-ruby27/root/usr/share/gems/doc/rack-2.2.8/rdoc/Rack/ |
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Rack::Response - rack-2.2.8 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="class">
<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">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link">Object
</div>
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="Response/Helpers.html">Rack::Response::Helpers</a>
</ul>
</div>
<!-- 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-new">::new</a>
<li ><a href="#method-i-5B-5D">#[]</a>
<li ><a href="#method-i-5B-5D-3D">#[]=</a>
<li ><a href="#method-i-chunked-3F">#chunked?</a>
<li ><a href="#method-i-close">#close</a>
<li ><a href="#method-i-delete_header">#delete_header</a>
<li ><a href="#method-i-each">#each</a>
<li ><a href="#method-i-empty-3F">#empty?</a>
<li ><a href="#method-i-finish">#finish</a>
<li ><a href="#method-i-get_header">#get_header</a>
<li ><a href="#method-i-has_header-3F">#has_header?</a>
<li ><a href="#method-i-redirect">#redirect</a>
<li ><a href="#method-i-set_header">#set_header</a>
<li ><a href="#method-i-to_a">#to_a</a>
<li ><a href="#method-i-write">#write</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Rack::Response">
<h1 id="class-Rack::Response" class="class">
class Rack::Response
</h1>
<section class="description">
<p><a href="Response.html"><code>Rack::Response</code></a> provides a convenient interface to create a <a href="../Rack.html"><code>Rack</code></a> response.</p>
<p>It allows setting of headers and cookies, and provides useful defaults (an OK response with empty headers and body).</p>
<p>You can use <a href="Response.html#method-i-write"><code>Response#write</code></a> to iteratively generate your response, but note that this is buffered by <a href="Response.html"><code>Rack::Response</code></a> until you call <code>finish</code>. <code>finish</code> however can take a block inside which calls to <code>write</code> are synchronous with the <a href="../Rack.html"><code>Rack</code></a> response.</p>
<p>Your application's <code>call</code> should end returning <a href="Response.html#method-i-finish"><code>Response#finish</code></a>.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="CHUNKED">CHUNKED
<dd>
<dt id="STATUS_WITH_NO_ENTITY_BODY">STATUS_WITH_NO_ENTITY_BODY
<dd>
</dl>
</section>
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-body" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">body</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-header" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">header</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-headers" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">headers</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-length" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">length</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-status" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">status</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
</div>
</div>
</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">(status, headers, body)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="5B-5D-source">
<pre><span class="ruby-comment"># File lib/rack/response.rb, line 19</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">[]</span>(<span class="ruby-identifier">status</span>, <span class="ruby-identifier">headers</span>, <span class="ruby-identifier">body</span>)
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">body</span>, <span class="ruby-identifier">status</span>, <span class="ruby-identifier">headers</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(body = nil, status = 200, headers = {}) { |self| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Initialize the response object with the specified body, status and headers.</p>
<p>@param body [nil, <a href="Response.html#method-i-each"><code>each</code></a>, to_str] the response body. @param status [Integer] the integer status as defined by the HTTP protocol RFCs. @param headers [#each] a list of key-value header pairs which conform to the HTTP protocol RFCs.</p>
<p>Providing a body which responds to to_str is legacy behaviour.</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rack/response.rb, line 42</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">body</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">status</span> = <span class="ruby-value">200</span>, <span class="ruby-identifier">headers</span> = {})
<span class="ruby-ivar">@status</span> = <span class="ruby-identifier">status</span>.<span class="ruby-identifier">to_i</span>
<span class="ruby-ivar">@headers</span> = <span class="ruby-constant">Utils</span><span class="ruby-operator">::</span><span class="ruby-constant">HeaderHash</span>[<span class="ruby-identifier">headers</span>]
<span class="ruby-ivar">@writer</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">method</span>(<span class="ruby-value">:append</span>)
<span class="ruby-ivar">@block</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-comment"># Keep track of whether we have expanded the user supplied body.</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">body</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-ivar">@body</span> = []
<span class="ruby-ivar">@buffered</span> = <span class="ruby-keyword">true</span>
<span class="ruby-ivar">@length</span> = <span class="ruby-value">0</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">body</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:to_str</span>)
<span class="ruby-ivar">@body</span> = [<span class="ruby-identifier">body</span>]
<span class="ruby-ivar">@buffered</span> = <span class="ruby-keyword">true</span>
<span class="ruby-ivar">@length</span> = <span class="ruby-identifier">body</span>.<span class="ruby-identifier">to_str</span>.<span class="ruby-identifier">bytesize</span>
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@body</span> = <span class="ruby-identifier">body</span>
<span class="ruby-ivar">@buffered</span> = <span class="ruby-keyword">false</span>
<span class="ruby-ivar">@length</span> = <span class="ruby-value">0</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">yield</span> <span class="ruby-keyword">self</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-5B-5D" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">[]</span><span
class="method-args">(key)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Response.html#method-i-get_header">get_header</a>
</div>
</div>
<div id="method-i-5B-5D-3D" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">[]=</span><span
class="method-args">(key, v)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Response.html#method-i-set_header">set_header</a>
</div>
</div>
<div id="method-i-chunked-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">chunked?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="chunked-3F-source">
<pre><span class="ruby-comment"># File lib/rack/response.rb, line 73</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">chunked?</span>
<span class="ruby-constant">CHUNKED</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">get_header</span>(<span class="ruby-constant">TRANSFER_ENCODING</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-close" class="method-detail ">
<div class="method-heading">
<span class="method-name">close</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="close-source">
<pre><span class="ruby-comment"># File lib/rack/response.rb, line 118</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">close</span>
<span class="ruby-ivar">@body</span>.<span class="ruby-identifier">close</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@body</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:close</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-delete_header" class="method-detail ">
<div class="method-heading">
<span class="method-name">delete_header</span><span
class="method-args">(key)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="delete_header-source">
<pre><span class="ruby-comment"># File lib/rack/response.rb, line 129</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">delete_header</span>(<span class="ruby-identifier">key</span>); <span class="ruby-identifier">headers</span>.<span class="ruby-identifier">delete</span> <span class="ruby-identifier">key</span>; <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-each" class="method-detail ">
<div class="method-heading">
<span class="method-name">each</span><span
class="method-args">(&callback)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="each-source">
<pre><span class="ruby-comment"># File lib/rack/response.rb, line 98</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">callback</span>)
<span class="ruby-ivar">@body</span>.<span class="ruby-identifier">each</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">callback</span>)
<span class="ruby-ivar">@buffered</span> = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@block</span>
<span class="ruby-ivar">@writer</span> = <span class="ruby-identifier">callback</span>
<span class="ruby-ivar">@block</span>.<span class="ruby-identifier">call</span>(<span class="ruby-keyword">self</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-empty-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">empty?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="empty-3F-source">
<pre><span class="ruby-comment"># File lib/rack/response.rb, line 122</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">empty?</span>
<span class="ruby-ivar">@block</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">nil</span> <span class="ruby-operator">&&</span> <span class="ruby-ivar">@body</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-finish" class="method-detail ">
<div class="method-heading">
<span class="method-name">finish</span><span
class="method-args">(&block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Generate a response array consistent with the requirements of the SPEC. @return [Array] a 3-tuple suitable of `[status, headers, body]` which is suitable to be returned from the middleware `#call(env)` method.</p>
<div class="method-source-code" id="finish-source">
<pre><span class="ruby-comment"># File lib/rack/response.rb, line 80</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">finish</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">if</span> <span class="ruby-constant">STATUS_WITH_NO_ENTITY_BODY</span>[<span class="ruby-identifier">status</span>.<span class="ruby-identifier">to_i</span>]
<span class="ruby-identifier">delete_header</span> <span class="ruby-constant">CONTENT_TYPE</span>
<span class="ruby-identifier">delete_header</span> <span class="ruby-constant">CONTENT_LENGTH</span>
<span class="ruby-identifier">close</span>
<span class="ruby-keyword">return</span> [<span class="ruby-ivar">@status</span>, <span class="ruby-ivar">@headers</span>, []]
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
<span class="ruby-ivar">@block</span> = <span class="ruby-identifier">block</span>
<span class="ruby-keyword">return</span> [<span class="ruby-ivar">@status</span>, <span class="ruby-ivar">@headers</span>, <span class="ruby-keyword">self</span>]
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">return</span> [<span class="ruby-ivar">@status</span>, <span class="ruby-ivar">@headers</span>, <span class="ruby-ivar">@body</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Response.html#method-i-to_a">to_a</a>
</div>
</div>
<div id="method-i-get_header" class="method-detail ">
<div class="method-heading">
<span class="method-name">get_header</span><span
class="method-args">(key)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="get_header-source">
<pre><span class="ruby-comment"># File lib/rack/response.rb, line 127</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_header</span>(<span class="ruby-identifier">key</span>); <span class="ruby-identifier">headers</span>[<span class="ruby-identifier">key</span>]; <span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Response.html#method-i-5B-5D">[]</a>
</div>
</div>
<div id="method-i-has_header-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">has_header?</span><span
class="method-args">(key)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="has_header-3F-source">
<pre><span class="ruby-comment"># File lib/rack/response.rb, line 126</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">has_header?</span>(<span class="ruby-identifier">key</span>); <span class="ruby-identifier">headers</span>.<span class="ruby-identifier">key?</span> <span class="ruby-identifier">key</span>; <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-redirect" class="method-detail ">
<div class="method-heading">
<span class="method-name">redirect</span><span
class="method-args">(target, status = 302)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="redirect-source">
<pre><span class="ruby-comment"># File lib/rack/response.rb, line 68</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">redirect</span>(<span class="ruby-identifier">target</span>, <span class="ruby-identifier">status</span> = <span class="ruby-value">302</span>)
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">status</span> = <span class="ruby-identifier">status</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">location</span> = <span class="ruby-identifier">target</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-set_header" class="method-detail ">
<div class="method-heading">
<span class="method-name">set_header</span><span
class="method-args">(key, v)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="set_header-source">
<pre><span class="ruby-comment"># File lib/rack/response.rb, line 128</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_header</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">v</span>); <span class="ruby-identifier">headers</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">v</span>; <span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Response.html#method-i-5B-5D-3D">[]=</a>
</div>
</div>
<div id="method-i-to_a" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">to_a</span><span
class="method-args">(&block)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Response.html#method-i-finish">finish</a>
</div>
</div>
<div id="method-i-write" class="method-detail ">
<div class="method-heading">
<span class="method-name">write</span><span
class="method-args">(chunk)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Append to body and update Content-Length.</p>
<p>NOTE: Do not mix <a href="Response.html#method-i-write"><code>write</code></a> and direct <a href="Response.html#attribute-i-body"><code>body</code></a> access!</p>
<div class="method-source-code" id="write-source">
<pre><span class="ruby-comment"># File lib/rack/response.rb, line 112</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write</span>(<span class="ruby-identifier">chunk</span>)
<span class="ruby-identifier">buffered_body!</span>
<span class="ruby-ivar">@writer</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">chunk</span>.<span class="ruby-identifier">to_s</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>