File: C:/Ruby27-x64/share/doc/ruby/html/URI/File.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class URI::File - 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="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">Generic
</div>
<!-- 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-build">::build</a>
<li ><a href="#method-i-check_password">#check_password</a>
<li ><a href="#method-i-check_user">#check_user</a>
<li ><a href="#method-i-check_userinfo">#check_userinfo</a>
<li ><a href="#method-i-set_host">#set_host</a>
<li ><a href="#method-i-set_password">#set_password</a>
<li ><a href="#method-i-set_port">#set_port</a>
<li ><a href="#method-i-set_user">#set_user</a>
<li ><a href="#method-i-set_userinfo">#set_userinfo</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-URI::File">
<h1 id="class-URI::File" class="class">
class URI::File
</h1>
<section class="description">
<p>The “file” <a href="../URI.html"><code>URI</code></a> is defined by RFC8089.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="COMPONENT">COMPONENT
<dd><p>An <a href="../Array.html"><code>Array</code></a> of the available components for <a href="File.html"><code>URI::File</code></a>.</p>
<dt id="DEFAULT_PORT">DEFAULT_PORT
<dd><p>A Default port of nil for <a href="File.html"><code>URI::File</code></a>.</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-build" class="method-detail ">
<div class="method-heading">
<span class="method-name">build</span><span
class="method-args">(args)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<h2 id="method-c-build-label-Description">Description<span><a href="#method-c-build-label-Description">¶</a> <a href="#top">↑</a></span></h2>
<p>Creates a new <a href="File.html"><code>URI::File</code></a> object from components, with syntax checking.</p>
<p>The components accepted are <code>host</code> and <code>path</code>.</p>
<p>The components should be provided either as an <a href="../Array.html"><code>Array</code></a>, or as a <a href="../Hash.html"><code>Hash</code></a> with keys formed by preceding the component names with a colon.</p>
<p>If an <a href="../Array.html"><code>Array</code></a> is used, the components must be passed in the order <code>[host, path]</code>.</p>
<p>Examples:</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'uri'</span>
<span class="ruby-identifier">uri1</span> = <span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">build</span>([<span class="ruby-string">'host.example.com'</span>, <span class="ruby-string">'/path/file.zip'</span>])
<span class="ruby-identifier">uri1</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-comment"># => "file://host.example.com/path/file.zip"</span>
<span class="ruby-identifier">uri2</span> = <span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">build</span>({<span class="ruby-value">:host</span> <span class="ruby-operator">=></span> <span class="ruby-string">'host.example.com'</span>,
<span class="ruby-value">:path</span> <span class="ruby-operator">=></span> <span class="ruby-string">'/ruby/src'</span>})
<span class="ruby-identifier">uri2</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-comment"># => "file://host.example.com/ruby/src"</span>
</pre>
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="build-source">
<pre><span class="ruby-comment"># File lib/uri/file.rb, line 47</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">build</span>(<span class="ruby-identifier">args</span>)
<span class="ruby-identifier">tmp</span> = <span class="ruby-constant">Util</span><span class="ruby-operator">::</span><span class="ruby-identifier">make_components_hash</span>(<span class="ruby-keyword">self</span>, <span class="ruby-identifier">args</span>)
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">tmp</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-check_password" class="method-detail ">
<div class="method-heading">
<span class="method-name">check_password</span><span
class="method-args">(user)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>raise <a href="InvalidURIError.html"><code>InvalidURIError</code></a></p>
<div class="method-source-code" id="check_password-source">
<pre><span class="ruby-comment"># File lib/uri/file.rb, line 76</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">check_password</span>(<span class="ruby-identifier">user</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">InvalidURIError</span>, <span class="ruby-string">"can not set password for file URI"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-check_user" class="method-detail ">
<div class="method-heading">
<span class="method-name">check_user</span><span
class="method-args">(user)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>raise <a href="InvalidURIError.html"><code>InvalidURIError</code></a></p>
<div class="method-source-code" id="check_user-source">
<pre><span class="ruby-comment"># File lib/uri/file.rb, line 71</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">check_user</span>(<span class="ruby-identifier">user</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">InvalidURIError</span>, <span class="ruby-string">"can not set user for file URI"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-check_userinfo" class="method-detail ">
<div class="method-heading">
<span class="method-name">check_userinfo</span><span
class="method-args">(user)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>raise <a href="InvalidURIError.html"><code>InvalidURIError</code></a></p>
<div class="method-source-code" id="check_userinfo-source">
<pre><span class="ruby-comment"># File lib/uri/file.rb, line 66</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">check_userinfo</span>(<span class="ruby-identifier">user</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">InvalidURIError</span>, <span class="ruby-string">"can not set userinfo for file URI"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-set_host" class="method-detail ">
<div class="method-heading">
<span class="method-name">set_host</span><span
class="method-args">(v)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Protected setter for the host component <code>v</code>.</p>
<p>See also <a href="Generic.html#method-i-host-3D"><code>URI::Generic.host=</code></a>.</p>
<div class="method-source-code" id="set_host-source">
<pre><span class="ruby-comment"># File lib/uri/file.rb, line 56</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_host</span>(<span class="ruby-identifier">v</span>)
<span class="ruby-identifier">v</span> = <span class="ruby-string">""</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">v</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">v</span> <span class="ruby-operator">==</span> <span class="ruby-string">"localhost"</span>
<span class="ruby-ivar">@host</span> = <span class="ruby-identifier">v</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-set_password" class="method-detail ">
<div class="method-heading">
<span class="method-name">set_password</span><span
class="method-args">(v)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>do nothing</p>
<div class="method-source-code" id="set_password-source">
<pre><span class="ruby-comment"># File lib/uri/file.rb, line 89</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_password</span>(<span class="ruby-identifier">v</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-set_port" class="method-detail ">
<div class="method-heading">
<span class="method-name">set_port</span><span
class="method-args">(v)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>do nothing</p>
<div class="method-source-code" id="set_port-source">
<pre><span class="ruby-comment"># File lib/uri/file.rb, line 62</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_port</span>(<span class="ruby-identifier">v</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-set_user" class="method-detail ">
<div class="method-heading">
<span class="method-name">set_user</span><span
class="method-args">(v)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>do nothing</p>
<div class="method-source-code" id="set_user-source">
<pre><span class="ruby-comment"># File lib/uri/file.rb, line 85</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_user</span>(<span class="ruby-identifier">v</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-set_userinfo" class="method-detail ">
<div class="method-heading">
<span class="method-name">set_userinfo</span><span
class="method-args">(v)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>do nothing</p>
<div class="method-source-code" id="set_userinfo-source">
<pre><span class="ruby-comment"># File lib/uri/file.rb, line 81</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_userinfo</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>