Viewing File: /opt/cpanel/ea-ruby27/root/usr/share/gems/doc/rack-2.2.24/rdoc/Rack/MediaType.html

<!DOCTYPE html>

<html>
<head>
<meta charset="UTF-8">

<title>class Rack::MediaType - rack-2.2.24 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-params">::params</a>
    
    <li ><a href="#method-c-strip_doublequotes">::strip_doublequotes</a>
    
    <li ><a href="#method-c-type">::type</a>
    
  </ul>
</div>

  </div>
</nav>

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

  <section class="description">
    
<p><a href="MediaType.html"><code>Rack::MediaType</code></a> parse media type and parameters out of content_type string</p>

  </section>

  
  <section id="5Buntitled-5D" class="documentation-section">
    

    

    
    <section class="constants-list">
      <header>
        <h3>Constants</h3>
      </header>
      <dl>
      
        <dt id="SPLIT_PATTERN">SPLIT_PATTERN
        
        <dd>
        
      
      </dl>
    </section>
    

    

    
     <section id="public-class-5Buntitled-5D-method-details" class="method-section">
       <header>
         <h3>Public Class Methods</h3>
       </header>

    
      <div id="method-c-params" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">params</span><span
            class="method-args">(content_type)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          <p>The media type parameters provided in CONTENT_TYPE as a Hash, or an empty Hash if no CONTENT_TYPE or media-type parameters were provided.  e.g., when the CONTENT_TYPE is “text/plain;charset=utf-8”, this method responds with the following Hash:</p>

<pre class="ruby">{ <span class="ruby-string">&#39;charset&#39;</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-string">&#39;utf-8&#39;</span> }
</pre>

<p>This will pass back parameters with empty strings in the hash if they lack a value (e.g., “text/plain;charset=” will return { &#39;charset&#39; =&gt; &#39;&#39; }, and “text/plain;charset” will return { &#39;charset&#39; =&gt; &#39;&#39; }, similarly to  the query params parser (barring the latter case, which returns nil instead)).</p>
          
          

          
          <div class="method-source-code" id="params-source">
            <pre><span class="ruby-comment"># File lib/rack/media_type.rb, line 35</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">params</span>(<span class="ruby-identifier">content_type</span>)
  <span class="ruby-keyword">return</span> {} <span class="ruby-keyword">if</span> <span class="ruby-identifier">content_type</span>.<span class="ruby-identifier">nil?</span>

  <span class="ruby-identifier">content_type</span>.<span class="ruby-identifier">split</span>(<span class="ruby-constant">SPLIT_PATTERN</span>)[<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>].<span class="ruby-identifier">each_with_object</span>({}) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">s</span>, <span class="ruby-identifier">hsh</span><span class="ruby-operator">|</span>
    <span class="ruby-identifier">s</span>.<span class="ruby-identifier">strip!</span>
    <span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span> = <span class="ruby-identifier">s</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">&#39;=&#39;</span>, <span class="ruby-value">2</span>)
    <span class="ruby-identifier">k</span>.<span class="ruby-identifier">downcase!</span>
    <span class="ruby-identifier">hsh</span>[<span class="ruby-identifier">k</span>] = <span class="ruby-identifier">strip_doublequotes</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-c-type" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">type</span><span
            class="method-args">(content_type)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          <p>The media type (type/subtype) portion of the CONTENT_TYPE header without any media type parameters. e.g., when CONTENT_TYPE is “text/plain;charset=utf-8”, the media-type is “text/plain”.</p>

<p>For more information on the use of media types in HTTP, see: <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7">www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7</a></p>
          
          

          
          <div class="method-source-code" id="type-source">
            <pre><span class="ruby-comment"># File lib/rack/media_type.rb, line 16</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">type</span>(<span class="ruby-identifier">content_type</span>)
  <span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">content_type</span>
  <span class="ruby-keyword">if</span> <span class="ruby-identifier">type</span> = <span class="ruby-identifier">content_type</span>.<span class="ruby-identifier">split</span>(<span class="ruby-constant">SPLIT_PATTERN</span>, <span class="ruby-value">2</span>).<span class="ruby-identifier">first</span>
    <span class="ruby-identifier">type</span>.<span class="ruby-identifier">rstrip!</span>
    <span class="ruby-identifier">type</span>.<span class="ruby-identifier">downcase!</span>
    <span class="ruby-identifier">type</span>
  <span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
    </section>
  
     <section id="private-class-5Buntitled-5D-method-details" class="method-section">
       <header>
         <h3>Private Class Methods</h3>
       </header>

    
      <div id="method-c-strip_doublequotes" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">strip_doublequotes</span><span
            class="method-args">(str)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="strip_doublequotes-source">
            <pre><span class="ruby-comment"># File lib/rack/media_type.rb, line 48</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">strip_doublequotes</span>(<span class="ruby-identifier">str</span>)
  (<span class="ruby-identifier">str</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">str</span>.<span class="ruby-identifier">start_with?</span>(<span class="ruby-string">&#39;&quot;&#39;</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">str</span>.<span class="ruby-identifier">end_with?</span>(<span class="ruby-string">&#39;&quot;&#39;</span>)) <span class="ruby-operator">?</span> <span class="ruby-identifier">str</span>[<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">-2</span>] <span class="ruby-operator">:</span> <span class="ruby-identifier">str</span> <span class="ruby-operator">||</span> <span class="ruby-string">&#39;&#39;</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>
Back to Directory