TripleDNN

Current Directory: /opt/cpanel/ea-ruby24/root/usr/share/gems/doc/rack-2.2.3/rdoc/Rack/Request

File Name	Size	Actions
Env.html	15174 bytes	Edit \| Delete \| Rename \| Download
Helpers.html	106653 bytes	Edit \| Delete \| Rename \| Download

<!DOCTYPE html>

<title>module Rack::Request::Env - rack-2.2.3 Documentation</title>

<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>

<div id="class-metadata">
    
    
    
    
    
<div id="method-list-section" class="nav-section">
  <h3>Methods</h3>

<ul class="link-list" role="directory">
    
    <li class="calls-super" ><a href="#method-c-new">::new</a>
    
    <li ><a href="#method-i-add_header">#add_header</a>
    
    <li ><a href="#method-i-delete_header">#delete_header</a>
    
    <li ><a href="#method-i-each_header">#each_header</a>
    
    <li ><a href="#method-i-fetch_header">#fetch_header</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-initialize_copy">#initialize_copy</a>
    
    <li ><a href="#method-i-set_header">#set_header</a>
    
  </ul>
</div>

</div>
</nav>

<main role="main" aria-labelledby="module-Rack::Request::Env">
  <h1 id="module-Rack::Request::Env" class="module">
    module Rack::Request::Env
  </h1>

<section class="attribute-method-details" class="method-section">
      <header>
        <h3>Attributes</h3>
      </header>

<div class="method-description">
        
        <p>The environment of the request.</p>
        
        </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-new" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">new</span><span
            class="method-args">(env)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>

<div class="method-description">
          
          
          
          
            <div class="method-calls-super">
              Calls superclass method
              
            </div>

<div class="method-source-code" id="new-source">
            <pre><span class="ruby-comment"># File lib/rack/request.rb, line 49</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">env</span>)
  <span class="ruby-ivar">@env</span> = <span class="ruby-identifier">env</span>
  <span class="ruby-keyword">super</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-add_header" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">add_header</span><span
            class="method-args">(key, v)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>

<div class="method-description">
          
          <p>Add a header that may have multiple values.</p>

<p>Example:</p>

<pre class="ruby"><span class="ruby-identifier">request</span>.<span class="ruby-identifier">add_header</span> <span class="ruby-string">&#39;Accept&#39;</span>, <span class="ruby-string">&#39;image/png&#39;</span>
<span class="ruby-identifier">request</span>.<span class="ruby-identifier">add_header</span> <span class="ruby-string">&#39;Accept&#39;</span>, <span class="ruby-string">&#39;*  &#39;</span>

<span class="ruby-identifier">assert_equal</span> <span class="ruby-string">&#39;image/png,  *&#39;</span>, <span class="ruby-identifier">request</span>.<span class="ruby-identifier">get_header</span>(<span class="ruby-string">&#39;Accept&#39;</span>)
</pre>

<p><a
href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2">www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2</a></p>

<div class="method-source-code" id="add_header-source">
            <pre><span class="ruby-comment"># File lib/rack/request.rb, line 90</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_header</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">v</span>)
  <span class="ruby-keyword">if</span> <span class="ruby-identifier">v</span>.<span class="ruby-identifier">nil?</span>
    <span class="ruby-identifier">get_header</span> <span class="ruby-identifier">key</span>
  <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">has_header?</span> <span class="ruby-identifier">key</span>
    <span class="ruby-identifier">set_header</span> <span class="ruby-identifier">key</span>, <span class="ruby-node">&quot;#{get_header key},#{v}&quot;</span>
  <span class="ruby-keyword">else</span>
    <span class="ruby-identifier">set_header</span> <span class="ruby-identifier">key</span>, <span class="ruby-identifier">v</span>
  <span class="ruby-keyword">end</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">(name)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>

<div class="method-description">
          
          <p>Delete a request specific value for `name`.</p>

<div class="method-source-code" id="delete_header-source">
            <pre><span class="ruby-comment"># File lib/rack/request.rb, line 101</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">delete_header</span>(<span class="ruby-identifier">name</span>)
  <span class="ruby-ivar">@env</span>.<span class="ruby-identifier">delete</span> <span class="ruby-identifier">name</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

</div>

<div id="method-i-each_header" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">each_header</span><span
            class="method-args">(&block)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>

<div class="method-description">
          
          <p>Loops through each key / value pair in the request specific data.</p>

<div class="method-source-code" id="each_header-source">
            <pre><span class="ruby-comment"># File lib/rack/request.rb, line 72</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">each_header</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
  <span class="ruby-ivar">@env</span>.<span class="ruby-identifier">each</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

</div>

<div id="method-i-fetch_header" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">fetch_header</span><span
            class="method-args">(name, &block)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>

<div class="method-description">
          
          <p>If a block is given, it yields to the block if the value hasn&#39;t been
set on the request.</p>

<div class="method-source-code" id="fetch_header-source">
            <pre><span class="ruby-comment"># File lib/rack/request.rb, line 67</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">fetch_header</span>(<span class="ruby-identifier">name</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
  <span class="ruby-ivar">@env</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">name</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </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">(name)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>

<div class="method-description">
          
          <p>Get a request specific value for `name`.</p>

<div class="method-source-code" id="get_header-source">
            <pre><span class="ruby-comment"># File lib/rack/request.rb, line 61</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_header</span>(<span class="ruby-identifier">name</span>)
  <span class="ruby-ivar">@env</span>[<span class="ruby-identifier">name</span>]
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </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">(name)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>

<div class="method-description">
          
          <p>Predicate method to test to see if `name` has been set as request specific
data</p>

<div class="method-source-code" id="has_header-3F-source">
            <pre><span class="ruby-comment"># File lib/rack/request.rb, line 56</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">has_header?</span>(<span class="ruby-identifier">name</span>)
  <span class="ruby-ivar">@env</span>.<span class="ruby-identifier">key?</span> <span class="ruby-identifier">name</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

</div>

<div id="method-i-initialize_copy" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">initialize_copy</span><span
            class="method-args">(other)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>

<div class="method-source-code" id="initialize_copy-source">
            <pre><span class="ruby-comment"># File lib/rack/request.rb, line 105</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize_copy</span>(<span class="ruby-identifier">other</span>)
  <span class="ruby-ivar">@env</span> = <span class="ruby-identifier">other</span>.<span class="ruby-identifier">env</span>.<span class="ruby-identifier">dup</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">(name, v)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>

<div class="method-description">
          
          <p>Set a request specific value for `name` to `v`</p>

<div class="method-source-code" id="set_header-source">
            <pre><span class="ruby-comment"># File lib/rack/request.rb, line 77</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">set_header</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">v</span>)
  <span class="ruby-ivar">@env</span>[<span class="ruby-identifier">name</span>] = <span class="ruby-identifier">v</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

</div>

</section>
  
  </section>
</main>

<footer id="validator-badges" role="contentinfo">
  <p><a href="http://validator.w3.org/check/referer">Validate</a>
  <p>Generated by <a href="https://rdoc.github.io/rdoc">RDoc</a> 5.0.1.
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>