OwlCyberSecurity - MANAGER
Edit File: BaseIterator.html
<!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>class Rack::Files::BaseIterator - 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="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-new">::new</a> <li ><a href="#method-i-bytesize">#bytesize</a> <li ><a href="#method-i-close">#close</a> <li ><a href="#method-i-each">#each</a> <li ><a href="#method-i-each_range_part">#each_range_part</a> <li ><a href="#method-i-multipart-3F">#multipart?</a> <li ><a href="#method-i-multipart_heading">#multipart_heading</a> </ul> </div> </div> </nav> <main role="main" aria-labelledby="class-Rack::Files::BaseIterator"> <h1 id="class-Rack::Files::BaseIterator" class="class"> class Rack::Files::BaseIterator </h1> <section class="description"> </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-options" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">options</span><span class="attribute-access-type">[R]</span> </div> <div class="method-description"> </div> </div> <div id="attribute-i-path" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">path</span><span class="attribute-access-type">[R]</span> </div> <div class="method-description"> </div> </div> <div id="attribute-i-ranges" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">ranges</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">(path, ranges, options)</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/rack/files.rb, line 126</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">ranges</span>, <span class="ruby-identifier">options</span>) <span class="ruby-ivar">@path</span> = <span class="ruby-identifier">path</span> <span class="ruby-ivar">@ranges</span> = <span class="ruby-identifier">ranges</span> <span class="ruby-ivar">@options</span> = <span class="ruby-identifier">options</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-bytesize" class="method-detail "> <div class="method-heading"> <span class="method-name">bytesize</span><span class="method-args">()</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="bytesize-source"> <pre><span class="ruby-comment"># File lib/rack/files.rb, line 146</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bytesize</span> <span class="ruby-identifier">size</span> = <span class="ruby-identifier">ranges</span>.<span class="ruby-identifier">inject</span>(<span class="ruby-value">0</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">sum</span>, <span class="ruby-identifier">range</span><span class="ruby-operator">|</span> <span class="ruby-identifier">sum</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">multipart_heading</span>(<span class="ruby-identifier">range</span>).<span class="ruby-identifier">bytesize</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">multipart?</span> <span class="ruby-identifier">sum</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">range</span>.<span class="ruby-identifier">size</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">size</span> <span class="ruby-operator">+=</span> <span class="ruby-node">"\r\n--#{MULTIPART_BOUNDARY}--\r\n"</span>.<span class="ruby-identifier">bytesize</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">multipart?</span> <span class="ruby-identifier">size</span> <span class="ruby-keyword">end</span></pre> </div> </div> </div> <div id="method-i-close" class="method-detail "> <div class="method-heading"> <span class="method-name">close</span><span class="method-args">()</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="close-source"> <pre><span class="ruby-comment"># File lib/rack/files.rb, line 155</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">close</span>; <span class="ruby-keyword">end</span></pre> </div> </div> </div> <div id="method-i-each" class="method-detail "> <div class="method-heading"> <span class="method-name">each</span><span class="method-args">() { |multipart_heading(range)| ... }</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="each-source"> <pre><span class="ruby-comment"># File lib/rack/files.rb, line 132</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">path</span>, <span class="ruby-string">"rb"</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span> <span class="ruby-identifier">ranges</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">range</span><span class="ruby-operator">|</span> <span class="ruby-keyword">yield</span> <span class="ruby-identifier">multipart_heading</span>(<span class="ruby-identifier">range</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">multipart?</span> <span class="ruby-identifier">each_range_part</span>(<span class="ruby-identifier">file</span>, <span class="ruby-identifier">range</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">part</span><span class="ruby-operator">|</span> <span class="ruby-keyword">yield</span> <span class="ruby-identifier">part</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">yield</span> <span class="ruby-node">"\r\n--#{MULTIPART_BOUNDARY}--\r\n"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">multipart?</span> <span class="ruby-keyword">end</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-each_range_part" class="method-detail "> <div class="method-heading"> <span class="method-name">each_range_part</span><span class="method-args">(file, range) { |part| ... }</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="each_range_part-source"> <pre><span class="ruby-comment"># File lib/rack/files.rb, line 173</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each_range_part</span>(<span class="ruby-identifier">file</span>, <span class="ruby-identifier">range</span>) <span class="ruby-identifier">file</span>.<span class="ruby-identifier">seek</span>(<span class="ruby-identifier">range</span>.<span class="ruby-identifier">begin</span>) <span class="ruby-identifier">remaining_len</span> = <span class="ruby-identifier">range</span>.<span class="ruby-identifier">end</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">range</span>.<span class="ruby-identifier">begin</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span> <span class="ruby-keyword">while</span> <span class="ruby-identifier">remaining_len</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span> <span class="ruby-identifier">part</span> = <span class="ruby-identifier">file</span>.<span class="ruby-identifier">read</span>([<span class="ruby-value">8192</span>, <span class="ruby-identifier">remaining_len</span>].<span class="ruby-identifier">min</span>) <span class="ruby-keyword">break</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">part</span> <span class="ruby-identifier">remaining_len</span> <span class="ruby-operator">-=</span> <span class="ruby-identifier">part</span>.<span class="ruby-identifier">length</span> <span class="ruby-keyword">yield</span> <span class="ruby-identifier">part</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span></pre> </div> </div> </div> <div id="method-i-multipart-3F" class="method-detail "> <div class="method-heading"> <span class="method-name">multipart?</span><span class="method-args">()</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="multipart-3F-source"> <pre><span class="ruby-comment"># File lib/rack/files.rb, line 159</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">multipart?</span> <span class="ruby-identifier">ranges</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">1</span> <span class="ruby-keyword">end</span></pre> </div> </div> </div> <div id="method-i-multipart_heading" class="method-detail "> <div class="method-heading"> <span class="method-name">multipart_heading</span><span class="method-args">(range)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="multipart_heading-source"> <pre><span class="ruby-comment"># File lib/rack/files.rb, line 163</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">multipart_heading</span>(<span class="ruby-identifier">range</span>) <span class="ruby-identifier"><<-EOF</span> <span class="ruby-value">\r --#{MULTIPART_BOUNDARY}\r Content-Type: #{options[:mime_type]}\r Content-Range: bytes #{range.begin}-#{range.end}/#{options[:size]}\r \r </span><span class="ruby-identifier">EOF</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>