← Back
Editing: Env.html
<!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>module Rack::Request::Env - rack-2.2.23 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 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="description"> </section> <section id="5Buntitled-5D" class="documentation-section"> <section class="attribute-method-details" class="method-section"> <header> <h3>Attributes</h3> </header> <div id="attribute-i-env" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">env</span><span class="attribute-access-type">[R]</span> </div> <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 50</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">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">'Accept'</span>, <span class="ruby-string">'image/png'</span> <span class="ruby-identifier">request</span>.<span class="ruby-identifier">add_header</span> <span class="ruby-string">'Accept'</span>, <span class="ruby-string">'*/*'</span> <span class="ruby-identifier">assert_equal</span> <span class="ruby-string">'image/png,*/*'</span>, <span class="ruby-identifier">request</span>.<span class="ruby-identifier">get_header</span>(<span class="ruby-string">'Accept'</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 91</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">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">"#{get_header key},#{v}"</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 102</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">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 73</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each_header</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) <span class="ruby-ivar">@env</span>.<span class="ruby-identifier">each</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-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'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 68</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">fetch_header</span>(<span class="ruby-identifier">name</span>, <span class="ruby-operator">&</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">&</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 62</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">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 57</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">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-description"> <div class="method-source-code" id="initialize_copy-source"> <pre><span class="ruby-comment"># File lib/rack/request.rb, line 106</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">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 78</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">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="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>
Save File
Cancel