File: C:/Ruby27-x64/share/doc/ruby/html/OpenURI/Meta.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module OpenURI::Meta - RDoc 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">
<div id="extends-section" class="nav-section">
<h3>Extended With Modules</h3>
<ul class="link-list">
<li><a class="extend" href="Meta.html">OpenURI::Meta</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-i-charset">#charset</a>
<li ><a href="#method-i-content_encoding">#content_encoding</a>
<li ><a href="#method-i-content_type">#content_type</a>
<li ><a href="#method-i-last_modified">#last_modified</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-OpenURI::Meta">
<h1 id="module-OpenURI::Meta" class="module">
module OpenURI::Meta
</h1>
<section class="description">
<p>Mixin for holding meta-information.</p>
</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-base_uri" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">base_uri</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>returns a <a href="../URI.html"><code>URI</code></a> that is the base of relative URIs in the data. It may differ from the <a href="../URI.html"><code>URI</code></a> supplied by a user due to redirection.</p>
</div>
</div>
<div id="attribute-i-meta" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">meta</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>returns a <a href="../Hash.html"><code>Hash</code></a> that represents header fields. The <a href="../Hash.html"><code>Hash</code></a> keys are downcased for canonicalization. The <a href="../Hash.html"><code>Hash</code></a> values are a field body. If there are multiple field with same field name, the field values are concatenated with a comma.</p>
</div>
</div>
<div id="attribute-i-metas" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">metas</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>returns a <a href="../Hash.html"><code>Hash</code></a> that represents header fields. The <a href="../Hash.html"><code>Hash</code></a> keys are downcased for canonicalization. The <a href="../Hash.html"><code>Hash</code></a> value are an array of field values.</p>
</div>
</div>
<div id="attribute-i-status" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">status</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>returns an <a href="../Array.html"><code>Array</code></a> that consists of status code and message.</p>
</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-charset" class="method-detail ">
<div class="method-heading">
<span class="method-name">charset</span><span
class="method-args">() { || ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>returns a charset parameter in Content-Type field. It is downcased for canonicalization.</p>
<p>If charset parameter is not given but a block is given, the block is called and its result is returned. It can be used to guess charset.</p>
<p>If charset parameter and block is not given, nil is returned except text type. In that case, “utf-8” is returned as defined by RFC6838 4.2.1</p>
<div class="method-source-code" id="charset-source">
<pre><span class="ruby-comment"># File lib/open-uri.rb, line 557</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">charset</span>
<span class="ruby-identifier">type</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">parameters</span> = <span class="ruby-identifier">content_type_parse</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">pair</span> = <span class="ruby-identifier">parameters</span>.<span class="ruby-identifier">assoc</span>(<span class="ruby-string">'charset'</span>)
<span class="ruby-identifier">pair</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">downcase</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">block_given?</span>
<span class="ruby-keyword">yield</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">type</span> <span class="ruby-operator">&&</span> <span class="ruby-regexp">%r{\Atext/}</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">type</span>
<span class="ruby-string">"utf-8"</span> <span class="ruby-comment"># RFC6838 4.2.1</span>
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-content_encoding" class="method-detail ">
<div class="method-heading">
<span class="method-name">content_encoding</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a list of encodings in Content-Encoding field as an array of strings.</p>
<p>The encodings are downcased for canonicalization.</p>
<div class="method-source-code" id="content_encoding-source">
<pre><span class="ruby-comment"># File lib/open-uri.rb, line 574</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">content_encoding</span>
<span class="ruby-identifier">vs</span> = <span class="ruby-ivar">@metas</span>[<span class="ruby-string">'content-encoding'</span>]
<span class="ruby-keyword">if</span> <span class="ruby-identifier">vs</span> <span class="ruby-operator">&&</span> <span class="ruby-regexp">%r{\A#{RE_LWS}?#{RE_TOKEN}#{RE_LWS}?(?:,#{RE_LWS}?#{RE_TOKEN}#{RE_LWS}?)*}o</span> <span class="ruby-operator">=~</span> (<span class="ruby-identifier">v</span> = <span class="ruby-identifier">vs</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">', '</span>))
<span class="ruby-identifier">v</span>.<span class="ruby-identifier">scan</span>(<span class="ruby-constant">RE_TOKEN</span>).<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">content_coding</span><span class="ruby-operator">|</span> <span class="ruby-identifier">content_coding</span>.<span class="ruby-identifier">downcase</span>}
<span class="ruby-keyword">else</span>
[]
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-content_type" class="method-detail ">
<div class="method-heading">
<span class="method-name">content_type</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>returns “type/subtype” which is MIME Content-Type. It is downcased for canonicalization. Content-Type parameters are stripped.</p>
<div class="method-source-code" id="content_type-source">
<pre><span class="ruby-comment"># File lib/open-uri.rb, line 542</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">content_type</span>
<span class="ruby-identifier">type</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">_</span> = <span class="ruby-identifier">content_type_parse</span>
<span class="ruby-identifier">type</span> <span class="ruby-operator">||</span> <span class="ruby-string">'application/octet-stream'</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-last_modified" class="method-detail ">
<div class="method-heading">
<span class="method-name">last_modified</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>returns a <a href="../Time.html"><code>Time</code></a> that represents the Last-Modified field.</p>
<div class="method-source-code" id="last_modified-source">
<pre><span class="ruby-comment"># File lib/open-uri.rb, line 504</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">last_modified</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">vs</span> = <span class="ruby-ivar">@metas</span>[<span class="ruby-string">'last-modified'</span>]
<span class="ruby-identifier">v</span> = <span class="ruby-identifier">vs</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">', '</span>)
<span class="ruby-constant">Time</span>.<span class="ruby-identifier">httpdate</span>(<span class="ruby-identifier">v</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</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>