File: C:/Ruby27-x64/share/doc/ruby/html/Net/FTP/MLSxEntry.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Net::FTP::MLSxEntry - 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"><a href="../../Object.html">Object</a>
</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-new">::new</a>
<li ><a href="#method-i-appendable-3F">#appendable?</a>
<li ><a href="#method-i-creatable-3F">#creatable?</a>
<li ><a href="#method-i-deletable-3F">#deletable?</a>
<li ><a href="#method-i-directory-3F">#directory?</a>
<li ><a href="#method-i-directory_makable-3F">#directory_makable?</a>
<li ><a href="#method-i-enterable-3F">#enterable?</a>
<li ><a href="#method-i-file-3F">#file?</a>
<li ><a href="#method-i-listable-3F">#listable?</a>
<li ><a href="#method-i-purgeable-3F">#purgeable?</a>
<li ><a href="#method-i-readable-3F">#readable?</a>
<li ><a href="#method-i-renamable-3F">#renamable?</a>
<li ><a href="#method-i-writable-3F">#writable?</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Net::FTP::MLSxEntry">
<h1 id="class-Net::FTP::MLSxEntry" class="class">
class Net::FTP::MLSxEntry
</h1>
<section class="description">
<p><a href="MLSxEntry.html"><code>MLSxEntry</code></a> represents an entry in responses of MLST/MLSD. Each entry has the facts (e.g., size, last modification time, etc.) and the pathname.</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-facts" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">facts</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-pathname" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">pathname</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
</section>
<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">(facts, pathname)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/net/ftp.rb, line 940</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">facts</span>, <span class="ruby-identifier">pathname</span>)
<span class="ruby-ivar">@facts</span> = <span class="ruby-identifier">facts</span>
<span class="ruby-ivar">@pathname</span> = <span class="ruby-identifier">pathname</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-appendable-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">appendable?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns <code>true</code> if the APPE command may be applied to the file.</p>
<div class="method-source-code" id="appendable-3F-source">
<pre><span class="ruby-comment"># File lib/net/ftp.rb, line 976</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">appendable?</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">facts</span>[<span class="ruby-string">"perm"</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-value">?a</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-creatable-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">creatable?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns <code>true</code> if files may be created in the directory by STOU, STOR, APPE, and RNTO.</p>
<div class="method-source-code" id="creatable-3F-source">
<pre><span class="ruby-comment"># File lib/net/ftp.rb, line 984</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">creatable?</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">facts</span>[<span class="ruby-string">"perm"</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-value">?c</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-deletable-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">deletable?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns <code>true</code> if the file or directory may be deleted by DELE/RMD.</p>
<div class="method-source-code" id="deletable-3F-source">
<pre><span class="ruby-comment"># File lib/net/ftp.rb, line 991</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">deletable?</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">facts</span>[<span class="ruby-string">"perm"</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-value">?d</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-directory-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">directory?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns <code>true</code> if the entry is a directory (i.e., the value of the type fact is dir, cdir, or pdir).</p>
<div class="method-source-code" id="directory-3F-source">
<pre><span class="ruby-comment"># File lib/net/ftp.rb, line 965</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">directory?</span>
<span class="ruby-keyword">if</span> <span class="ruby-regexp">/\A[cp]?dir\z/</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">facts</span>[<span class="ruby-string">"type"</span>])
<span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span>
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-directory_makable-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">directory_makable?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns <code>true</code> if the MKD command may be used to create a new directory within the directory.</p>
<div class="method-source-code" id="directory_makable-3F-source">
<pre><span class="ruby-comment"># File lib/net/ftp.rb, line 1021</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">directory_makable?</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">facts</span>[<span class="ruby-string">"perm"</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-value">?m</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-enterable-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">enterable?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns <code>true</code> if the directory may be entered by CWD/CDUP.</p>
<div class="method-source-code" id="enterable-3F-source">
<pre><span class="ruby-comment"># File lib/net/ftp.rb, line 998</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">enterable?</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">facts</span>[<span class="ruby-string">"perm"</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-value">?e</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-file-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">file?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns <code>true</code> if the entry is a file (i.e., the value of the type fact is file).</p>
<div class="method-source-code" id="file-3F-source">
<pre><span class="ruby-comment"># File lib/net/ftp.rb, line 957</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">file?</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">facts</span>[<span class="ruby-string">"type"</span>] <span class="ruby-operator">==</span> <span class="ruby-string">"file"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-listable-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">listable?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns <code>true</code> if the listing commands, LIST, NLST, and MLSD are applied to the directory.</p>
<div class="method-source-code" id="listable-3F-source">
<pre><span class="ruby-comment"># File lib/net/ftp.rb, line 1013</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">listable?</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">facts</span>[<span class="ruby-string">"perm"</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-value">?l</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-purgeable-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">purgeable?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns <code>true</code> if the objects in the directory may be deleted, or the directory may be purged.</p>
<div class="method-source-code" id="purgeable-3F-source">
<pre><span class="ruby-comment"># File lib/net/ftp.rb, line 1029</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">purgeable?</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">facts</span>[<span class="ruby-string">"perm"</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-value">?p</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-readable-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">readable?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns <code>true</code> if the RETR command may be applied to the file.</p>
<div class="method-source-code" id="readable-3F-source">
<pre><span class="ruby-comment"># File lib/net/ftp.rb, line 1036</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">readable?</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">facts</span>[<span class="ruby-string">"perm"</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-value">?r</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-renamable-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">renamable?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns <code>true</code> if the file or directory may be renamed by RNFR.</p>
<div class="method-source-code" id="renamable-3F-source">
<pre><span class="ruby-comment"># File lib/net/ftp.rb, line 1005</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">renamable?</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">facts</span>[<span class="ruby-string">"perm"</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-value">?f</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-writable-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">writable?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns <code>true</code> if the STOR command may be applied to the file.</p>
<div class="method-source-code" id="writable-3F-source">
<pre><span class="ruby-comment"># File lib/net/ftp.rb, line 1043</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">writable?</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">facts</span>[<span class="ruby-string">"perm"</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-value">?w</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>