KOKINIO - MANAGER
Edit File: RewindableInput.html
<?xml version="1.0" encoding="iso-8859-1"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <title>Class: Rack::RewindableInput</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> <meta http-equiv="Content-Script-Type" content="text/javascript" /> <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" /> <script type="text/javascript"> // <![CDATA[ function popupCode( url ) { window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400") } function toggleCode( id ) { if ( document.getElementById ) elem = document.getElementById( id ); else if ( document.all ) elem = eval( "document.all." + id ); else return false; elemStyle = elem.style; if ( elemStyle.display != "block" ) { elemStyle.display = "block" } else { elemStyle.display = "none" } return true; } // Make codeblocks hidden by default document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" ) // ]]> </script> </head> <body> <div id="classHeader"> <table class="header-table"> <tr class="top-aligned-row"> <td><strong>Class</strong></td> <td class="class-name-in-header">Rack::RewindableInput</td> </tr> <tr class="top-aligned-row"> <td><strong>In:</strong></td> <td> <a href="../../files/lib/rack/rewindable_input_rb.html"> lib/rack/rewindable_input.rb </a> <br /> </td> </tr> <tr class="top-aligned-row"> <td><strong>Parent:</strong></td> <td> Object </td> </tr> </table> </div> <!-- banner header --> <div id="bodyContent"> <div id="contextContent"> <div id="description"> <p> Class which can make any IO object rewindable, including non-rewindable ones. It does this by buffering the data into a tempfile, which is rewindable. </p> <p> rack.input is required to be rewindable, so if your input stream IO is non-rewindable by nature (e.g. a pipe or a socket) then you can wrap it in an object of this class to easily make it rewindable. </p> <p> Don‘t forget to call <a href="RewindableInput.html#M000450">close</a> when you‘re done. This frees up temporary resources that <a href="RewindableInput.html">RewindableInput</a> uses, though it does <b>not</b> <a href="RewindableInput.html#M000450">close</a> the original IO object. </p> </div> </div> <div id="method-list"> <h3 class="section-bar">Methods</h3> <div class="name-list"> <a href="#M000450">close</a> <a href="#M000448">each</a> <a href="#M000446">gets</a> <a href="#M000445">new</a> <a href="#M000447">read</a> <a href="#M000449">rewind</a> </div> </div> </div> <!-- if includes --> <div id="section"> <div id="class-list"> <h3 class="section-bar">Classes and Modules</h3> Class <a href="RewindableInput/Tempfile.html" class="link">Rack::RewindableInput::Tempfile</a><br /> </div> <!-- if method_list --> <div id="methods"> <h3 class="section-bar">Public Class methods</h3> <div id="method-M000445" class="method-detail"> <a name="M000445"></a> <div class="method-heading"> <a href="RewindableInput.src/M000445.html" target="Code" class="method-signature" onclick="popupCode('RewindableInput.src/M000445.html');return false;"> <span class="method-name">new</span><span class="method-args">(io)</span> </a> </div> <div class="method-description"> </div> </div> <h3 class="section-bar">Public Instance methods</h3> <div id="method-M000450" class="method-detail"> <a name="M000450"></a> <div class="method-heading"> <a href="RewindableInput.src/M000450.html" target="Code" class="method-signature" onclick="popupCode('RewindableInput.src/M000450.html');return false;"> <span class="method-name">close</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p> Closes this <a href="RewindableInput.html">RewindableInput</a> object without closing the originally wrapped IO oject. Cleans up any temporary resources that this <a href="RewindableInput.html">RewindableInput</a> has created. </p> <p> This method may be called multiple times. It does nothing on subsequent calls. </p> </div> </div> <div id="method-M000448" class="method-detail"> <a name="M000448"></a> <div class="method-heading"> <a href="RewindableInput.src/M000448.html" target="Code" class="method-signature" onclick="popupCode('RewindableInput.src/M000448.html');return false;"> <span class="method-name">each</span><span class="method-args">(&block)</span> </a> </div> <div class="method-description"> </div> </div> <div id="method-M000446" class="method-detail"> <a name="M000446"></a> <div class="method-heading"> <a href="RewindableInput.src/M000446.html" target="Code" class="method-signature" onclick="popupCode('RewindableInput.src/M000446.html');return false;"> <span class="method-name">gets</span><span class="method-args">()</span> </a> </div> <div class="method-description"> </div> </div> <div id="method-M000447" class="method-detail"> <a name="M000447"></a> <div class="method-heading"> <a href="RewindableInput.src/M000447.html" target="Code" class="method-signature" onclick="popupCode('RewindableInput.src/M000447.html');return false;"> <span class="method-name">read</span><span class="method-args">(*args)</span> </a> </div> <div class="method-description"> </div> </div> <div id="method-M000449" class="method-detail"> <a name="M000449"></a> <div class="method-heading"> <a href="RewindableInput.src/M000449.html" target="Code" class="method-signature" onclick="popupCode('RewindableInput.src/M000449.html');return false;"> <span class="method-name">rewind</span><span class="method-args">()</span> </a> </div> <div class="method-description"> </div> </div> </div> </div> <div id="validator-badges"> <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p> </div> </body> </html>