Da

✏️ Editing: Params.html

<!DOCTYPE html>

<title>class Rack::QueryParser::Params - rack-2.2.23 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="parent-class-section" class="nav-section">
  <h3>Parent</h3>

<p class="link">Object
  
</div>

<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-5B-5D">#[]</a>
    
    <li ><a href="#method-i-5B-5D-3D">#[]=</a>
    
    <li ><a href="#method-i-key-3F">#key?</a>
    
    <li ><a href="#method-i-to_h">#to_h</a>
    
    <li ><a href="#method-i-to_params_hash">#to_params_hash</a>
    
  </ul>
</div>

</div>
</nav>

<main role="main" aria-labelledby="class-Rack::QueryParser::Params">
  <h1 id="class-Rack::QueryParser::Params" class="class">
    class Rack::QueryParser::Params
  </h1>

<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">(limit)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>

<div class="method-source-code" id="new-source">
            <pre><span class="ruby-comment"># File lib/rack/query_parser.rb, line 208</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">limit</span>)
  <span class="ruby-ivar">@limit</span>  = <span class="ruby-identifier">limit</span>
  <span class="ruby-ivar">@size</span>   = <span class="ruby-value">0</span>
  <span class="ruby-ivar">@params</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 ">
        
        <div class="method-heading">
          <span class="method-name">[]</span><span
            class="method-args">(key)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>

<div class="method-source-code" id="5B-5D-source">
            <pre><span class="ruby-comment"># File lib/rack/query_parser.rb, line 214</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">[]</span>(<span class="ruby-identifier">key</span>)
  <span class="ruby-ivar">@params</span>[<span class="ruby-identifier">key</span>]
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

</div>

<div id="method-i-5B-5D-3D" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">[]=</span><span
            class="method-args">(key, value)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>

<div class="method-source-code" id="5B-5D-3D-source">
            <pre><span class="ruby-comment"># File lib/rack/query_parser.rb, line 218</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">[]=</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span>)
  <span class="ruby-ivar">@size</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">key</span>.<span class="ruby-identifier">size</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">key</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@params</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-identifier">key</span>)
  <span class="ruby-identifier">raise</span> <span class="ruby-constant">ParamsTooDeepError</span>, <span class="ruby-string">&#39;exceeded available parameter key space&#39;</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@size</span> <span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@limit</span>
  <span class="ruby-ivar">@params</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

</div>

<div id="method-i-key-3F" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">key?</span><span
            class="method-args">(key)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>

<div class="method-source-code" id="key-3F-source">
            <pre><span class="ruby-comment"># File lib/rack/query_parser.rb, line 224</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">key?</span>(<span class="ruby-identifier">key</span>)
  <span class="ruby-ivar">@params</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-to_h" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">to_h</span><span
            class="method-args">()</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>

<div class="method-description">
          
          <p>Recursively unwraps nested `Params` objects and constructs an object of the same shape, but using the objects&#39; internal representations (Ruby hashes) in place of the objects. The result is a hash consisting purely of Ruby primitives.</p>

<pre>Mutation warning!

1. This method mutates the internal representation of the `Params`
   objects in order to save object allocations.

2. The value you get back is a reference to the internal hash
   representation, not a copy.

3. Because the `Params` object&#39;s internal representation is mutable
   through the `#[]=` method, it is not thread safe. The result of
   getting the hash representation while another thread is adding a
   key to it is non-deterministic.</pre>

<div class="method-source-code" id="to_h-source">
            <pre><span class="ruby-comment"># File lib/rack/query_parser.rb, line 246</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_h</span>
  <span class="ruby-ivar">@params</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
    <span class="ruby-keyword">case</span> <span class="ruby-identifier">value</span>
    <span class="ruby-keyword">when</span> <span class="ruby-keyword">self</span>
      <span class="ruby-comment"># Handle circular references gracefully.</span>
      <span class="ruby-ivar">@params</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-ivar">@params</span>
    <span class="ruby-keyword">when</span> <span class="ruby-constant">Params</span>
      <span class="ruby-ivar">@params</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">value</span>.<span class="ruby-identifier">to_h</span>
    <span class="ruby-keyword">when</span> <span class="ruby-constant">Array</span>
      <span class="ruby-identifier">value</span>.<span class="ruby-identifier">map!</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">v</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">Params</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">v</span>.<span class="ruby-identifier">to_h</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">v</span> }
    <span class="ruby-keyword">else</span>
      <span class="ruby-comment"># Ignore anything that is not a `Params` object or</span>
      <span class="ruby-comment"># a collection that can contain one.</span>
    <span class="ruby-keyword">end</span>
  <span class="ruby-keyword">end</span>
  <span class="ruby-ivar">@params</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

<div class="aliases">
          Also aliased as: <a href="Params.html#method-i-to_params_hash">to_params_hash</a>
        </div>

</div>

<div id="method-i-to_params_hash" class="method-detail method-alias">
        
        <div class="method-heading">
          <span class="method-name">to_params_hash</span><span
            class="method-args">()</span>
          
        </div>

</div>

<div class="aliases">
          Alias for: <a href="Params.html#method-i-to_h">to_h</a>
        </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>

📁 Sid Gifari File Manager