%PDF-
%PDF-
Mini Shell
Mini Shell
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Rack::BodyProxy - rack-2.2.10 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>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-close">#close</a>
<li ><a href="#method-i-closed-3F">#closed?</a>
<li ><a href="#method-i-method_missing">#method_missing</a>
<li class="calls-super" ><a href="#method-i-respond_to_missing-3F">#respond_to_missing?</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Rack::BodyProxy">
<h1 id="class-Rack::BodyProxy" class="class">
class Rack::BodyProxy
</h1>
<section class="description">
<p>Proxy for response bodies allowing calling a block when the response body is closed (after the response has been fully sent to the client).</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-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(body, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Set the response body to wrap, and the block to call when the response has been fully sent.</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rack/body_proxy.rb, line 10</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">body</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-ivar">@body</span> = <span class="ruby-identifier">body</span>
<span class="ruby-ivar">@block</span> = <span class="ruby-identifier">block</span>
<span class="ruby-ivar">@closed</span> = <span class="ruby-keyword">false</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-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">
<p>If not already closed, close the wrapped body and then call the block the proxy was initialized with.</p>
<div class="method-source-code" id="close-source">
<pre><span class="ruby-comment"># File lib/rack/body_proxy.rb, line 23</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">close</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@closed</span>
<span class="ruby-ivar">@closed</span> = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">begin</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">ensure</span>
<span class="ruby-ivar">@block</span>.<span class="ruby-identifier">call</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-closed-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">closed?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Whether the proxy is closed. The proxy starts as not closed, and becomes closed on the first call to close.</p>
<div class="method-source-code" id="closed-3F-source">
<pre><span class="ruby-comment"># File lib/rack/body_proxy.rb, line 35</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">closed?</span>
<span class="ruby-ivar">@closed</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-method_missing" class="method-detail ">
<div class="method-heading">
<span class="method-name">method_missing</span><span
class="method-args">(method_name, *args, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Delegate missing methods to the wrapped body.</p>
<div class="method-source-code" id="method_missing-source">
<pre><span class="ruby-comment"># File lib/rack/body_proxy.rb, line 40</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">method_missing</span>(<span class="ruby-identifier">method_name</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-ivar">@body</span>.<span class="ruby-identifier">__send__</span>(<span class="ruby-identifier">method_name</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-respond_to_missing-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">respond_to_missing?</span><span
class="method-args">(method_name, include_all = false)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return whether the wrapped body responds to the method.</p>
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="respond_to_missing-3F-source">
<pre><span class="ruby-comment"># File lib/rack/body_proxy.rb, line 17</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">respond_to_missing?</span>(<span class="ruby-identifier">method_name</span>, <span class="ruby-identifier">include_all</span> = <span class="ruby-keyword">false</span>)
<span class="ruby-keyword">super</span> <span class="ruby-keyword">or</span> <span class="ruby-ivar">@body</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">method_name</span>, <span class="ruby-identifier">include_all</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>
Zerion Mini Shell 1.0