RubyGems - steam-condenser - Versions diffs - 1.3.8.1 → 1.3.9 - Mend

steam-condenser 1.3.8.1 → 1.3.9

Files changed (476) hide show

data/pkg/steam-condenser-1.3.8.1/doc/StringIO.html ADDED Viewed

@@ -0,0 +1,986 @@
+<!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>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: StringIO
+    &mdash; Metior — API Documentation
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!" + escape(window.location.href);
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html">Index (S)</a> &raquo;
+    <span class="title">StringIO</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Class: StringIO
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Object</span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">StringIO</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/core_ext/stringio.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>This extends the <code>StringIO</code> class from Ruby&#39;s standard
+library. It adds some
+methods to handle byte-wise input from a
+<code>StringIO</code> object.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Author:</p>
+<ul class="author">
+    <li>
+        <div class='inline'>
+<p>Sebastian Staudt</p>
+</div>
+    </li>
+</ul>
+</div>
+    <h2>
+      Class Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#alloc-class_method" title="alloc (class method)">+ (StringIO) <strong>alloc</strong>(size) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Creates a new instance of <code>StringIO</code> with the given size and
+fills it with zero-bytes.</p>
+</div></span>
+</li>
+    </ul>
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#byte-instance_method" title="#byte (instance method)">- (Fixnum) <strong>byte</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Reads a single byte from the current position of the byte stream.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#cstring-instance_method" title="#cstring (instance method)">- (String) <strong>cstring</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Reads a zero-byte terminated string from the current position of the byte
+stream.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#float-instance_method" title="#float (instance method)">- (Float) <strong>float</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Reads a floating-point integer (32 bit) from the current position of the
+byte stream.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#get-instance_method" title="#get (instance method)">- (String) <strong>get</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Reads the whole remaining content of the byte stream from the current
+position to the end.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#long-instance_method" title="#long (instance method)">- (Fixnum) <strong>long</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Reads an unsigned long integer (32 bit) from the current position of the
+byte stream.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#remaining-instance_method" title="#remaining (instance method)">- (Fixnum) <strong>remaining</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the remaining number of bytes from the current position to the end
+of the byte stream.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#short-instance_method" title="#short (instance method)">- (Fixnum) <strong>short</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Reads an unsigned short integer (16 bit) from the current position of the
+byte stream.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#signed_long-instance_method" title="#signed_long (instance method)">- (Fixnum) <strong>signed_long</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Reads a signed long integer (32 bit) from the current position of the byte
+stream.</p>
+</div></span>
+</li>
+    </ul>
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="alloc-class_method">
+    + (<tt><span class='object_link'><a href="" title="StringIO (class)">StringIO</a></span></tt>) <strong>alloc</strong>(size)
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Creates a new instance of <code>StringIO</code> with the given size and
+fills it with
+zero-bytes.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>size</span>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The size the new instance should have</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="" title="StringIO (class)">StringIO</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>A new <code>StringIO</code> instance with the given size, filled
+with
+zero-bytes</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+20
+21
+22</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/core_ext/stringio.rb', line 20</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_alloc'>alloc</span><span class='lparen'>(</span><span class='id identifier rubyid_size'>size</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_new'>new</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\0</span><span class='tstring_end'>&quot;</span></span> <span class='op'>*</span> <span class='id identifier rubyid_size'>size</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="byte-instance_method">
+    - (<tt>Fixnum</tt>) <strong>byte</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Reads a single byte from the current position of the byte stream</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The numeric value of the byte at the current position</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+27
+28
+29</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/core_ext/stringio.rb', line 27</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_byte'>byte</span>
+  <span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='int'>1</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_ord'>ord</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="cstring-instance_method">
+    - (<tt>String</tt>) <strong>cstring</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Reads a zero-byte terminated string from the current position of the
+byte
+stream</p>
+<p>This reads the stream up until the first occurrence of a zero-byte or
+the
+end of the stream. The zero-byte is not included in the returned
+string.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The zero-byte terminated string read from the byte stream</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+87
+88
+89
+90
+91</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/core_ext/stringio.rb', line 87</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_cstring'>cstring</span>
+  <span class='id identifier rubyid_string'>string</span> <span class='op'>=</span> <span class='id identifier rubyid_gets'>gets</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\0</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='int'>0</span><span class='op'>..</span><span class='op'>-</span><span class='int'>2</span><span class='rbracket'>]</span>
+  <span class='id identifier rubyid_string'>string</span><span class='period'>.</span><span class='id identifier rubyid_force_encoding'>force_encoding</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>UTF-8</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_string'>string</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span> <span class='symbol'>:force_encoding</span>
+  <span class='id identifier rubyid_string'>string</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="float-instance_method">
+    - (<tt>Float</tt>) <strong>float</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Reads a floating-point integer (32 bit) from the current position of
+the
+byte stream</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Float</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The floating-point integer read from the byte stream</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+35
+36
+37</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/core_ext/stringio.rb', line 35</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_float'>float</span>
+  <span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='int'>4</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_unpack'>unpack</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>e</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="get-instance_method">
+    - (<tt>String</tt>) <strong>get</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Reads the whole remaining content of the byte stream from the
+current
+position to the end</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The remainder of the byte stream starting from the current
+position of the
+byte stream</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+44
+45
+46</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/core_ext/stringio.rb', line 44</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span>
+  <span class='id identifier rubyid_read'>read</span> <span class='id identifier rubyid_remaining'>remaining</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="long-instance_method">
+    - (<tt>Fixnum</tt>) <strong>long</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Reads an unsigned long integer (32 bit) from the current position of
+the
+byte stream</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The unsigned long integer read from the byte stream</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+52
+53
+54</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/core_ext/stringio.rb', line 52</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_long'>long</span>
+  <span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='int'>4</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_unpack'>unpack</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>V</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="remaining-instance_method">
+    - (<tt>Fixnum</tt>) <strong>remaining</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the remaining number of bytes from the current position to the
+end
+of the byte stream</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The number of bytes until the end of the stream</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+60
+61
+62</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/core_ext/stringio.rb', line 60</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_remaining'>remaining</span>
+  <span class='id identifier rubyid_size'>size</span> <span class='op'>-</span> <span class='id identifier rubyid_pos'>pos</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="short-instance_method">
+    - (<tt>Fixnum</tt>) <strong>short</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Reads an unsigned short integer (16 bit) from the current position of
+the
+byte stream</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The unsigned short integer read from the byte stream</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+68
+69
+70</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/core_ext/stringio.rb', line 68</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_short'>short</span>
+  <span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='int'>2</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_unpack'>unpack</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>v</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="signed_long-instance_method">
+    - (<tt>Fixnum</tt>) <strong>signed_long</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Reads a signed long integer (32 bit) from the current position of the
+byte
+stream</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The signed long integer read from the byte stream</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+76
+77
+78</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/core_ext/stringio.rb', line 76</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_signed_long'>signed_long</span>
+  <span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='int'>4</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_unpack'>unpack</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>l</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Tue Jul 22 07:10:18 2014 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.3 (ruby-2.0.0).
+</div>
+  </body>
+</html>