autodoc.git / traditional_manual / chapter_9.html

version» Context lines:

autodoc.git/traditional_manual/chapter_9.html:498:   <p> Proxy function for <code>Fd::read()</code>, that adds support for    the buffering configured by <code>set_buffer_mode()</code></p>   </dd>   <dt class='head--doc'>See also</dt>   <dd class='body--doc'><p><code>read_function()</code>, <code>write()</code>, <code>Fd::read()</code></p>   </dd></dl>         <hr />   <dl class='group--doc'> - <dt class='head--type'><span class='homogen--type'>Typedef</span> - <span class='homogen--name'><b>read_callback_t</b></span> - </dt> - <dd><p><code><code class='datatype'>typedef</code> <code class='datatype'>function</code>(<code class='datatype'>mixed</code>|<code class='datatype'>void</code>, <code class='datatype'>string</code>:<code class='datatype'>int</code>|<code class='datatype'>void</code>)|<code class='datatype'>function</code>(<code class='datatype'>mixed</code>|<code class='datatype'>void</code>, <code class='object unresolved'>Buffer</code>:<code class='datatype'>int</code>|<code class='datatype'>void</code>)|<code class='datatype'>function</code>(<code class='datatype'>mixed</code>|<code class='datatype'>void</code>:<code class='datatype'>int</code>|<code class='datatype'>void</code>) Stdio.File.<code class='typedef'>read_callback_t</code></code></p></dd> -  - <dt class='head--doc'>Description</dt> - <dd class='body--doc'><p>The various read_callback signatures.</p> - <p> The string (or void) version is used when buffer mode (see -  <code>set_buffer_mode</code>) has not been enabled for reading.</p> - <p> The Buffer version is used when an Buffer has been enabled -  for reading</p> - <p> In both cases the data is the newly arrived data, but in buffered -  mode data you did not fully read in the last read callback is -  kept in the buffer.</p> - </dd></dl> -  -  - <hr /> - <dl class='group--doc'> +    <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>read_function</b></span>   </dt>   <dd><p><code><code class='datatype'>function</code>(:<code class='datatype'>string</code>) <b><span class='method'>read_function</span>(</b><code class='datatype'>int</code> <code class='argument'>nbytes</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Returns a function that when called will call <code>read</code> with    nbytes as argument. Can be used to get various callback    functions, eg for the fourth argument to    <code>String.SplitIterator</code>.</p>
autodoc.git/traditional_manual/chapter_9.html:911:   </pre></dd>   <dt class='head--doc'>Note</dt>   <dd class='body--doc'><p>Unknown flags are ignored by <code>tcsetattr()</code>. <code>tcsetattr</code> always    changes the attribute, so only include attributes that actually    should be altered in the attribute mapping.</p>   </dd>   <dt class='head--doc'>Bugs</dt>   <dd class='body--doc'><p>Terminal rows and columns setting by <code>tcsetattr()</code> is not    currently supported.</p>   </dd></dl> -  -  - <hr /> - <dl class='group--doc'> - <dt class='head--type'><span class='homogen--type'>Typedef</span> - <span class='homogen--name'><b>write_callback_t</b></span> - </dt> - <dd><p><code><code class='datatype'>typedef</code> <code class='datatype'>function</code>(<code class='datatype'>mixed</code>|<code class='datatype'>void</code>:<code class='datatype'>int</code>|<code class='datatype'>void</code>)|<code class='datatype'>function</code>(<code class='datatype'>mixed</code>|<code class='datatype'>void</code>, <code class='object unresolved'>Buffer</code>:<code class='datatype'>int</code>|<code class='datatype'>void</code>) Stdio.File.<code class='typedef'>write_callback_t</code></code></p></dd> -  - <dt class='head--doc'>Description</dt> - <dd class='body--doc'><p>The various read_callback signatures.</p> - <p> The void version is used when buffer mode (see -  <code>set_buffer_mode</code>) has not been enabled for writing.</p> - <p> The Buffer version is used when an Buffer has been enabled -  for reading, add data to that buffer to send it.</p> - </dd></dl> +    </dd></dl><dl><dt><h2 class='header'>Class <b class='ms datatype'>Stdio.FILE</b></h2>   </dt><dd><dl class='group--doc'>   <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p><code>Stdio.FILE</code> is a buffered version of <code>Stdio.File</code>, it inherits    <code>Stdio.File</code> and has most of the functionality of <code>Stdio.File</code>.    However, it has an input buffer that allows line-by-line input.</p>   <p> It also has support for automatic charset conversion for both input    and output (see <code>Stdio.FILE()-&gt;set_charset()</code>).</p>   </dd>   <dt class='head--doc'>Note</dt>
autodoc.git/traditional_manual/chapter_9.html:4003:    <code>start</code> is beyond the end of it.</p>   <p> Returns a string with the requested data otherwise.</p>   </dd>   <dt class='head--doc'>See also</dt>   <dd class='body--doc'><p><code>read_file</code>, <code>write_file()</code>, <code>append_file()</code></p>   </dd></dl>         <hr />   <dl class='group--doc'> + <dt class='head--type'><span class='homogen--type'>Typedef</span> + <span class='homogen--name'><b>read_callback_t</b></span> + </dt> + <dd><p><code><code class='datatype'><code class='modifier'>local</code> typedef</code> <code class='datatype'>function</code>(<code class='datatype'>mixed</code>|<code class='datatype'>void</code>, <code class='datatype'>string</code>:<code class='datatype'>int</code>|<code class='datatype'>void</code>)|<code class='datatype'>function</code>(<code class='datatype'>mixed</code>|<code class='datatype'>void</code>, <code class='object unresolved'>Buffer</code>:<code class='datatype'>int</code>|<code class='datatype'>void</code>)|<code class='datatype'>function</code>(<code class='datatype'>mixed</code>|<code class='datatype'>void</code>:<code class='datatype'>int</code>|<code class='datatype'>void</code>) Stdio.<code class='typedef'>read_callback_t</code></code></p></dd> +  + <dt class='head--doc'>Description</dt> + <dd class='body--doc'><p>The various read_callback signatures.</p> + <p> The string (or void) version is used when buffer mode (see +  <code>set_buffer_mode</code>) has not been enabled for reading.</p> + <p> The Buffer version is used when an Buffer has been enabled +  for reading</p> + <p> In both cases the data is the newly arrived data, but in buffered +  mode data you did not fully read in the last read callback is +  kept in the buffer.</p> + </dd></dl> +  +  + <hr /> + <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>read_file</b></span>   </dt>   <dd><p><code><code class='datatype'>string</code> <b><span class='method'>read_file</span>(</b><code class='datatype'>string</code> <code class='argument'>filename</code><b>)</b></code><br>   <code><code class='datatype'>string</code> <b><span class='method'>read_file</span>(</b><code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>int</code> <code class='argument'>start</code>, <code class='datatype'>int</code> <code class='argument'>len</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Read <code>len</code> lines from a regular file <code>filename</code> after skipping    <code>start</code> lines and return those lines as a string. If both    <code>start</code> and <code>len</code> are omitted the whole file is read.</p>
autodoc.git/traditional_manual/chapter_9.html:4198:   <dt class='head--doc'>Note</dt>   <dd class='body--doc'><p>This function is identical to <code>predef::werror()</code>.</p>   </dd>   <dt class='head--doc'>See also</dt>   <dd class='body--doc'><p><code>predef::werror()</code></p>   </dd></dl>         <hr />   <dl class='group--doc'> + <dt class='head--type'><span class='homogen--type'>Typedef</span> + <span class='homogen--name'><b>write_callback_t</b></span> + </dt> + <dd><p><code><code class='datatype'><code class='modifier'>local</code> typedef</code> <code class='datatype'>function</code>(<code class='datatype'>mixed</code>|<code class='datatype'>void</code>:<code class='datatype'>int</code>|<code class='datatype'>void</code>)|<code class='datatype'>function</code>(<code class='datatype'>mixed</code>|<code class='datatype'>void</code>, <code class='object unresolved'>Buffer</code>:<code class='datatype'>int</code>|<code class='datatype'>void</code>) Stdio.<code class='typedef'>write_callback_t</code></code></p></dd> +  + <dt class='head--doc'>Description</dt> + <dd class='body--doc'><p>The various write_callback signatures.</p> + <p> The void version is used when buffer mode (see +  <code>set_buffer_mode</code>) has not been enabled for writing.</p> + <p> The Buffer version is used when an Buffer has been enabled +  for reading, add data to that buffer to send it.</p> + </dd></dl> +  +  + <hr /> + <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>write_file</b></span>   </dt>   <dd><p><code><code class='datatype'>int</code> <b><span class='method'>write_file</span>(</b><code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>string</code> <code class='argument'>str</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>access</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Write the string <code>str</code> onto the file <code>filename</code>. Any existing    data in the file is overwritten.</p>   <p> For a description of <code>access</code>, see <code>Stdio.File()-&gt;open()</code>.</p>   </dd>