OwlCyberSecurity - MANAGER
Edit File: GzipStream.html
<!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>class Rack::Deflater::GzipStream - 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-close">#close</a> <li ><a href="#method-i-each">#each</a> <li ><a href="#method-i-write">#write</a> </ul> </div> </div> </nav> <main role="main" aria-labelledby="class-Rack::Deflater::GzipStream"> <h1 id="class-Rack::Deflater::GzipStream" class="class"> class Rack::Deflater::GzipStream </h1> <section class="description"> <p>Body class used for gzip encoded responses.</p> </section> <section id="5Buntitled-5D" class="documentation-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">(body, mtime, sync)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <p>Initialize the gzip stream. Arguments:</p> <dl class="rdoc-list note-list"><dt>body <dd> <p><a href="../Response.html"><code>Response</code></a> body to compress with gzip</p> </dd><dt>mtime <dd> <p>The modification time of the body, used to set the modification time in the gzip header.</p> </dd><dt>sync <dd> <p>Whether to flush each gzip chunk as soon as it is ready.</p> </dd></dl> <div class="method-source-code" id="new-source"> <pre><span class="ruby-comment"># File lib/rack/deflater.rb, line 85</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">body</span>, <span class="ruby-identifier">mtime</span>, <span class="ruby-identifier">sync</span>) <span class="ruby-ivar">@body</span> = <span class="ruby-identifier">body</span> <span class="ruby-ivar">@mtime</span> = <span class="ruby-identifier">mtime</span> <span class="ruby-ivar">@sync</span> = <span class="ruby-identifier">sync</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-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"> <p>Close the original body if possible.</p> <div class="method-source-code" id="close-source"> <pre><span class="ruby-comment"># File lib/rack/deflater.rb, line 114</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">close</span> <span class="ruby-ivar">@body</span>.<span class="ruby-identifier">close</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@body</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">: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">(&block)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <p>Yield gzip compressed strings to the given block.</p> <div class="method-source-code" id="each-source"> <pre><span class="ruby-comment"># File lib/rack/deflater.rb, line 92</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) <span class="ruby-ivar">@writer</span> = <span class="ruby-identifier">block</span> <span class="ruby-identifier">gzip</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Zlib</span><span class="ruby-operator">::</span><span class="ruby-constant">GzipWriter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword">self</span>) <span class="ruby-identifier">gzip</span>.<span class="ruby-identifier">mtime</span> = <span class="ruby-ivar">@mtime</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@mtime</span> <span class="ruby-ivar">@body</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">part</span><span class="ruby-operator">|</span> <span class="ruby-comment"># Skip empty strings, as they would result in no output,</span> <span class="ruby-comment"># and flushing empty parts would raise Zlib::BufError.</span> <span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">part</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-identifier">gzip</span>.<span class="ruby-identifier">write</span>(<span class="ruby-identifier">part</span>) <span class="ruby-identifier">gzip</span>.<span class="ruby-identifier">flush</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@sync</span> } <span class="ruby-keyword">ensure</span> <span class="ruby-identifier">gzip</span>.<span class="ruby-identifier">close</span> <span class="ruby-keyword">end</span></pre> </div> </div> </div> <div id="method-i-write" class="method-detail "> <div class="method-heading"> <span class="method-name">write</span><span class="method-args">(data)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <p>Call the block passed to <a href="GzipStream.html#method-i-each"><code>each</code></a> with the the gzipped data.</p> <div class="method-source-code" id="write-source"> <pre><span class="ruby-comment"># File lib/rack/deflater.rb, line 109</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write</span>(<span class="ruby-identifier">data</span>) <span class="ruby-ivar">@writer</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">data</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>