Diff of autodoc.git/traditional_manual/chapter_9.html (1b92b855bc714f7614dc16b8dde9f46b2385d5f7 » 89eb1e589953b5d912bc1b1ed1caebdd4acb2dd0)

autodoc.git/traditional_manual/chapter_9.html:4434: </dt> <dd><code><code class='object unresolved'>Buffer</code> add_hstring(<code class='datatype'>string(8bit)</code> <code class='argument'>data</code>, <code class='datatype'>int</code> <code class='argument'>size_size</code>)</code> <code><code class='object unresolved'>Buffer</code> add_hstring(<code class='object unresolved'>Stdio.Buffer</code> <code class='argument'>data</code>, <code class='datatype'>int</code> <code class='argument'>size_size</code>)</code> <code><code class='object unresolved'>Buffer</code> add_hstring(<code class='object unresolved'>System.Memory</code> <code class='argument'>data</code>, <code class='datatype'>int</code> <code class='argument'>size_size</code>)</code> <code><code class='object unresolved'>Buffer</code> add_hstring(<code class='object unresolved'>String.Buffer</code> <code class='argument'>data</code>, <code class='datatype'>int</code> <code class='argument'>size_size</code>)</code> <code><code class='object unresolved'>Buffer</code> add_hstring(<code class='datatype'>array</code> <code class='argument'>data</code>, <code class='datatype'>int</code> <code class='argument'>size_size</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Adds length of data followed by <code>data</code> to the buffer. This is identical to - <tt>sprintf("%"+size_size+"H",(string)Stdio.IObuffer(data))</tt> but + <tt>sprintf("%"+size_size+"H",(string)Stdio.Buffer(data))</tt> but significantly faster. <code>size_size</code> is the number of bytes used to represent the length of the data. It must be less than Int.NATIVE_MAX. The supported <code>data</code> argument types are <table class='box'><tr><td><code><code class='datatype'>string(8bit)</code></code></td><td>An eight bit string. </td></tr> <tr><td><code><code class='object unresolved'>System.Memory</code></code></td><td>A chunk of memory. The whole memory area is added. </td></tr> <tr><td><code><code class='object unresolved'>Stdio.Buffer</code></code></td><td>A chunk of memory. The whole memory area is added. </td></tr>
autodoc.git/traditional_manual/chapter_9.html:5007: buffer from being rewound. The second version (<code>rewind_key</code>) requires you to explicitly call <code>RewindKey.rewind</code> to do the rewind. Take some care with these objects, if you create multiple ones at once the results might be somewhat confusing if you do not release them in the reverse order they were created in (then again, you almost certainly really only need one) You can call <code>RewindKey.update</code> in the generated object to change where it will be rewound to. The typical use-case of this functionality is when parsing a - packet protocol with variable length packets where the lenght is + packet protocol with variable length packets where the length is not immediately known. It saves you from keeping track of how much to rewind if you had not actually gotten the whole packet yet. </dd> <dt class='head--doc'>Example</dt> <dd class='example'><pre><pre><code>void parse_packet( Stdio.Buffer b ) { Stdio.Buffer.RewindKey rewind = b->rewind_on_error(); b->set_error_mode(1); switch( b->read_int8() ) // packet type { case DATA: int channel = b->read_int8(); Stdio.Buffer data = b->read_hbuffer( 4 ); // we have read the whole packet, so no longer rewind on error. rewind->release(); - return handle_data_packet( chennel, data ); + return handle_data_packet( channel, data ); } } </code></pre></pre></dd> <dt class='head--doc'>Note</dt> <dd class='body--doc'>Just calling <code>rewind_on_error</code> without assigning the return value to something will not do anything. You need to keep the object around while the rewind-to position is still valid. Keeping the object around forbids the buffer from moving data inside itself, this means that it can only grow. So do not keep the rewind key when it is not needed.

autodoc.git / traditional_manual / chapter_9.html