AlkantarClanX12

Your IP : 18.119.142.210


Current Path : /proc/self/root/opt/cpanel/ea-ruby27/root/usr/share/gems/doc/rack-2.2.10/rdoc/Rack/
Upload File :
Current File : //proc/self/root/opt/cpanel/ea-ruby27/root/usr/share/gems/doc/rack-2.2.10/rdoc/Rack/Mime.html

<!DOCTYPE html>

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

<title>module Rack::Mime - 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="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 ><a href="#method-c-match-3F">::match?</a>
    
    <li ><a href="#method-c-mime_type">::mime_type</a>
    
    <li ><a href="#method-i-match-3F">#match?</a>
    
    <li ><a href="#method-i-mime_type">#mime_type</a>
    
  </ul>
</div>

  </div>
</nav>

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

  <section class="description">
    
  </section>

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

    

    
    <section class="constants-list">
      <header>
        <h3>Constants</h3>
      </header>
      <dl>
      
        <dt id="MIME_TYPES">MIME_TYPES
        
        <dd><p>List of most common mime-types, selected various sources according to their usefulness in a webserving scope for Ruby users.</p>

<p>To amend this list with your local mime.types list you can use:</p>

<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;webrick/httputils&#39;</span>
<span class="ruby-identifier">list</span> = <span class="ruby-constant">WEBrick</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPUtils</span>.<span class="ruby-identifier">load_mime_types</span>(<span class="ruby-string">&#39;/etc/mime.types&#39;</span>)
<span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">Mime</span><span class="ruby-operator">::</span><span class="ruby-constant">MIME_TYPES</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">list</span>)
</pre>

<p>N.B. On Ubuntu the mime.types file does not include the leading period, so users may need to modify the data before merging into the hash.</p>
        
      
      </dl>
    </section>
    

    

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

    
      <div id="method-c-match-3F" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">match?</span><span
            class="method-args">(value, matcher)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          <p>Returns true if the given value is a mime match for the given mime match specification, false otherwise.</p>

<pre>Rack::Mime.match?(&#39;text/html&#39;, &#39;text/*&#39;) =&gt; true
Rack::Mime.match?(&#39;text/plain&#39;, &#39;*&#39;) =&gt; true
Rack::Mime.match?(&#39;text/html&#39;, &#39;application/json&#39;) =&gt; false</pre>
          
          

          
          <div class="method-source-code" id="match-3F-source">
            <pre><span class="ruby-comment"># File lib/rack/mime.rb, line 30</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">match?</span>(<span class="ruby-identifier">value</span>, <span class="ruby-identifier">matcher</span>)
  <span class="ruby-identifier">v1</span>, <span class="ruby-identifier">v2</span> = <span class="ruby-identifier">value</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">&#39;/&#39;</span>, <span class="ruby-value">2</span>)
  <span class="ruby-identifier">m1</span>, <span class="ruby-identifier">m2</span> = <span class="ruby-identifier">matcher</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">&#39;/&#39;</span>, <span class="ruby-value">2</span>)

  (<span class="ruby-identifier">m1</span> <span class="ruby-operator">==</span> <span class="ruby-string">&#39;*&#39;</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">v1</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">m1</span>) <span class="ruby-operator">&amp;&amp;</span> (<span class="ruby-identifier">m2</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">m2</span> <span class="ruby-operator">==</span> <span class="ruby-string">&#39;*&#39;</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">m2</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">v2</span>)
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-c-mime_type" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">mime_type</span><span
            class="method-args">(ext, fallback = &#39;application/octet-stream&#39;)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          <p>Returns String with mime type if found, otherwise use <code>fallback</code>. <code>ext</code> should be filename extension in the &#39;.ext&#39; format that</p>

<pre>File.extname(file) returns.</pre>

<p><code>fallback</code> may be any object</p>

<p>Also see the documentation for <a href="Mime.html#MIME_TYPES"><code>MIME_TYPES</code></a></p>

<p>Usage:</p>

<pre class="ruby"><span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">Mime</span>.<span class="ruby-identifier">mime_type</span>(<span class="ruby-string">&#39;.foo&#39;</span>)
</pre>

<p>This is a shortcut for:</p>

<pre class="ruby"><span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">Mime</span><span class="ruby-operator">::</span><span class="ruby-constant">MIME_TYPES</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-string">&#39;.foo&#39;</span>, <span class="ruby-string">&#39;application/octet-stream&#39;</span>)
</pre>
          
          

          
          <div class="method-source-code" id="mime_type-source">
            <pre><span class="ruby-comment"># File lib/rack/mime.rb, line 18</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">mime_type</span>(<span class="ruby-identifier">ext</span>, <span class="ruby-identifier">fallback</span> = <span class="ruby-string">&#39;application/octet-stream&#39;</span>)
  <span class="ruby-constant">MIME_TYPES</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">ext</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">downcase</span>, <span class="ruby-identifier">fallback</span>)
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

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

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

        <div class="method-description">
          
          <p>Returns true if the given value is a mime match for the given mime match specification, false otherwise.</p>

<pre>Rack::Mime.match?(&#39;text/html&#39;, &#39;text/*&#39;) =&gt; true
Rack::Mime.match?(&#39;text/plain&#39;, &#39;*&#39;) =&gt; true
Rack::Mime.match?(&#39;text/html&#39;, &#39;application/json&#39;) =&gt; false</pre>
          
          

          
          <div class="method-source-code" id="match-3F-source">
            <pre><span class="ruby-comment"># File lib/rack/mime.rb, line 30</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">match?</span>(<span class="ruby-identifier">value</span>, <span class="ruby-identifier">matcher</span>)
  <span class="ruby-identifier">v1</span>, <span class="ruby-identifier">v2</span> = <span class="ruby-identifier">value</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">&#39;/&#39;</span>, <span class="ruby-value">2</span>)
  <span class="ruby-identifier">m1</span>, <span class="ruby-identifier">m2</span> = <span class="ruby-identifier">matcher</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">&#39;/&#39;</span>, <span class="ruby-value">2</span>)

  (<span class="ruby-identifier">m1</span> <span class="ruby-operator">==</span> <span class="ruby-string">&#39;*&#39;</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">v1</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">m1</span>) <span class="ruby-operator">&amp;&amp;</span> (<span class="ruby-identifier">m2</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">m2</span> <span class="ruby-operator">==</span> <span class="ruby-string">&#39;*&#39;</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">m2</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">v2</span>)
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-i-mime_type" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">mime_type</span><span
            class="method-args">(ext, fallback = &#39;application/octet-stream&#39;)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          <p>Returns String with mime type if found, otherwise use <code>fallback</code>. <code>ext</code> should be filename extension in the &#39;.ext&#39; format that</p>

<pre>File.extname(file) returns.</pre>

<p><code>fallback</code> may be any object</p>

<p>Also see the documentation for <a href="Mime.html#MIME_TYPES"><code>MIME_TYPES</code></a></p>

<p>Usage:</p>

<pre class="ruby"><span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">Mime</span>.<span class="ruby-identifier">mime_type</span>(<span class="ruby-string">&#39;.foo&#39;</span>)
</pre>

<p>This is a shortcut for:</p>

<pre class="ruby"><span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">Mime</span><span class="ruby-operator">::</span><span class="ruby-constant">MIME_TYPES</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-string">&#39;.foo&#39;</span>, <span class="ruby-string">&#39;application/octet-stream&#39;</span>)
</pre>
          
          

          
          <div class="method-source-code" id="mime_type-source">
            <pre><span class="ruby-comment"># File lib/rack/mime.rb, line 18</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">mime_type</span>(<span class="ruby-identifier">ext</span>, <span class="ruby-identifier">fallback</span> = <span class="ruby-string">&#39;application/octet-stream&#39;</span>)
  <span class="ruby-constant">MIME_TYPES</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">ext</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">downcase</span>, <span class="ruby-identifier">fallback</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>