<?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: RFuzz::PushBackIO</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">RFuzz::PushBackIO</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../files/lib/rfuzz/pushbackio_rb.html">
lib/rfuzz/pushbackio.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>
A simple class that using a StringIO object internally to allow for faster
and simpler "push back" semantics. It basically lets you read a
random amount from a secondary IO object, parse what is needed, and then
anything remaining can be quickly pushed back in one chunk for the next
read.
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000018">close</a>
<a href="#M000016">flush</a>
<a href="#M000010">new</a>
<a href="#M000013">pop</a>
<a href="#M000019">protect</a>
<a href="#M000012">push</a>
<a href="#M000011">random_death</a>
<a href="#M000015">read</a>
<a href="#M000014">reset</a>
<a href="#M000017">write</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<div id="attribute-list">
<h3 class="section-bar">Attributes</h3>
<div class="name-list">
<table>
<tr class="top-aligned-row context-row">
<td class="context-item-name">secondary</td>
<td class="context-item-value"> [RW] </td>
<td class="context-item-desc"></td>
</tr>
</table>
</div>
</div>
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000010" class="method-detail">
<a name="M000010"></a>
<div class="method-heading">
<a href="PushBackIO.src/M000010.html" target="Code" class="method-signature"
onclick="popupCode('PushBackIO.src/M000010.html');return false;">
<span class="method-name">new</span><span class="method-args">(secondary)</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000018" class="method-detail">
<a name="M000018"></a>
<div class="method-heading">
<a href="PushBackIO.src/M000018.html" target="Code" class="method-signature"
onclick="popupCode('PushBackIO.src/M000018.html');return false;">
<span class="method-name">close</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000016" class="method-detail">
<a name="M000016"></a>
<div class="method-heading">
<a href="PushBackIO.src/M000016.html" target="Code" class="method-signature"
onclick="popupCode('PushBackIO.src/M000016.html');return false;">
<span class="method-name">flush</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000013" class="method-detail">
<a name="M000013"></a>
<div class="method-heading">
<a href="PushBackIO.src/M000013.html" target="Code" class="method-signature"
onclick="popupCode('PushBackIO.src/M000013.html');return false;">
<span class="method-name">pop</span><span class="method-args">(n)</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000019" class="method-detail">
<a name="M000019"></a>
<div class="method-heading">
<a href="PushBackIO.src/M000019.html" target="Code" class="method-signature"
onclick="popupCode('PushBackIO.src/M000019.html');return false;">
<span class="method-name">protect</span><span class="method-args">() {|| ...}</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000012" class="method-detail">
<a name="M000012"></a>
<div class="method-heading">
<a href="PushBackIO.src/M000012.html" target="Code" class="method-signature"
onclick="popupCode('PushBackIO.src/M000012.html');return false;">
<span class="method-name">push</span><span class="method-args">(content)</span>
</a>
</div>
<div class="method-description">
<p>
Pushes the given string content back onto the stream for the next read to
handle.
</p>
</div>
</div>
<div id="method-M000011" class="method-detail">
<a name="M000011"></a>
<div class="method-heading">
<a href="PushBackIO.src/M000011.html" target="Code" class="method-signature"
onclick="popupCode('PushBackIO.src/M000011.html');return false;">
<span class="method-name">random_death</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000015" class="method-detail">
<a name="M000015"></a>
<div class="method-heading">
<a href="PushBackIO.src/M000015.html" target="Code" class="method-signature"
onclick="popupCode('PushBackIO.src/M000015.html');return false;">
<span class="method-name">read</span><span class="method-args">(n, partial=false)</span>
</a>
</div>
<div class="method-description">
<p>
First does a read from the internal buffer, and then appends anything
needed from the secondary IO to complete the request. The return value is
guaranteed to be a String, and never nil. If it returns a string of length
0 then there is nothing to read from the buffer (most likely closed). It
will also avoid reading from a secondary that’s closed.
</p>
<p>
If partial==true then readpartial is used instead.
</p>
</div>
</div>
<div id="method-M000014" class="method-detail">
<a name="M000014"></a>
<div class="method-heading">
<a href="PushBackIO.src/M000014.html" target="Code" class="method-signature"
onclick="popupCode('PushBackIO.src/M000014.html');return false;">
<span class="method-name">reset</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000017" class="method-detail">
<a name="M000017"></a>
<div class="method-heading">
<a href="PushBackIO.src/M000017.html" target="Code" class="method-signature"
onclick="popupCode('PushBackIO.src/M000017.html');return false;">
<span class="method-name">write</span><span class="method-args">(content)</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>