Mercurial Repositories > eric / file diff

diff: Documentation/Source/eric5.DebugClients.Ruby.AsyncFile.html

Documentation/Source/eric5.DebugClients.Ruby.AsyncFile.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
diff -r 81326a94fdca -r 37f0444c3479 Documentation/Source/eric5.DebugClients.Ruby.AsyncFile.html
--- a/Documentation/Source/eric5.DebugClients.Ruby.AsyncFile.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.DebugClients.Ruby.AsyncFile.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.DebugClients.Ruby.AsyncFile</h1>
 <p>
-&#70;&#105;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97;&#110; &#97;&#115;y&#110;&#99;&#104;&#114;&#111;&#110;&#111;&#117;&#115; &#102;&#105;&#108;&#101; &#108;&#105;&#107;&#101; &#115;&#111;&#99;&#107;&#101;&#116; &#105;&#110;&#116;&#101;&#114;&#102;&#97;&#99;&#101; &#102;&#111;&#114; &#116;&#104;&#101; &#100;&#101;&#98;&#117;&#103;&#103;&#101;&#114;.
+File implementing an asynchronous file like socket interface for the debugger.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,7 +32,7 @@
 <table>
 <tr>
 <td><a href="#AsyncFile">AsyncFile</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; w&#114;&#97;&#112;&#112;&#105;&#110;&#103; &#97; &#115;&#111;&#99;&#107;&#101;&#116; &#111;&#98;&#106;&#101;&#99;&#116; w&#105;&#116;&#104; &#97; &#102;&#105;&#108;&#101; &#105;&#110;&#116;&#101;&#114;&#102;&#97;&#99;&#101;.</td>
+<td>Class wrapping a socket object with a file interface.</td>
 </tr>
 </table>
 <h3>Modules</h3>
@@ -43,56 +43,56 @@
 <table>
 <tr>
 <td><a href="#<<"><<</a></td>
-<td>&#83;y&#110;&#111;&#110;y&#109; &#102;&#111;&#114; w&#114;&#105;&#116;&#101;(&#115;).</td>
+<td>Synonym for write(s).</td>
 </tr><tr>
 <td><a href="#AsyncPendingWrite">AsyncPendingWrite</a></td>
-<td>&#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#102;&#111;&#114; &#100;&#97;&#116;&#97; &#116;&#111; &#98;&#101; w&#114;&#105;&#116;&#116;&#101;&#110;.</td>
+<td>Module function to check for data to be written.</td>
 </tr><tr>
 <td><a href="#close">close</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#108;&#111;&#115;&#101; &#116;&#104;&#101; &#102;&#105;&#108;&#101;.</td>
+<td>Public method to close the file.</td>
 </tr><tr>
 <td><a href="#fileno">fileno</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#114;&#101;&#116;&#117;&#114;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#102;&#105;&#108;&#101; &#110;&#117;&#109;&#98;&#101;&#114;.</td>
+<td>Public method returning the file number.</td>
 </tr><tr>
 <td><a href="#flush">flush</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; w&#114;&#105;&#116;&#101; &#97;&#108;&#108; &#112;&#101;&#110;&#100;&#105;&#110;&#103; &#98;y&#116;&#101;&#115;.</td>
+<td>Public method to write all pending bytes.</td>
 </tr><tr>
 <td><a href="#getSock">getSock</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#115;&#111;&#99;&#107;&#101;&#116; &#111;&#98;&#106;&#101;&#99;&#116;.</td>
+<td>Public method to get the socket object.</td>
 </tr><tr>
 <td><a href="#isatty">isatty</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#101; w&#104;&#101;&#116;&#104;&#101;&#114; &#97; &#116;&#116;y &#105;&#110;&#116;&#101;&#114;&#102;&#97;&#99;&#101; &#105;&#115; &#115;&#117;&#112;&#112;&#111;&#114;&#116;&#101;&#100;.</td>
+<td>Public method to indicate whether a tty interface is supported.</td>
 </tr><tr>
 <td><a href="#pendingWrite">pendingWrite</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#104;&#97;&#116; &#114;&#101;&#116;&#117;&#114;&#110;&#115; &#116;&#104;&#101; &#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#98;y&#116;&#101;&#115; w&#97;&#105;&#116;&#105;&#110;&#103; &#116;&#111; &#98;&#101; w&#114;&#105;&#116;&#116;&#101;&#110;.</td>
+<td>Public method that returns the number of bytes waiting to be written.</td>
 </tr><tr>
 <td><a href="#read">read</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#98;y&#116;&#101;&#115; &#102;&#114;&#111;&#109; &#116;&#104;&#105;&#115; &#102;&#105;&#108;&#101;.</td>
+<td>Public method to read bytes from this file.</td>
 </tr><tr>
 <td><a href="#readline">readline</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#97; &#108;&#105;&#110;&#101; &#102;&#114;&#111;&#109; &#116;&#104;&#105;&#115; &#102;&#105;&#108;&#101;.</td>
+<td>Public method to read a line from this file.</td>
 </tr><tr>
 <td><a href="#readlines">readlines</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#97;&#108;&#108; &#108;&#105;&#110;&#101;&#115; &#102;&#114;&#111;&#109; &#116;&#104;&#105;&#115; &#102;&#105;&#108;&#101;.</td>
+<td>Public method to read all lines from this file.</td>
 </tr><tr>
 <td><a href="#seek">seek</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#109;&#111;v&#101; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#112;&#111;&#105;&#110;&#116;&#101;&#114;.</td>
+<td>Public method to move the filepointer.</td>
 </tr><tr>
 <td><a href="#tell">tell</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#112;&#111;&#105;&#110;&#116;&#101;&#114; &#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110;.</td>
+<td>Public method to get the filepointer position.</td>
 </tr><tr>
 <td><a href="#write">write</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; w&#114;&#105;&#116;&#101; &#97; &#115;&#116;&#114;&#105;&#110;&#103; &#116;&#111; &#116;&#104;&#101; &#102;&#105;&#108;&#101;.</td>
+<td>Public method to write a string to the file.</td>
 </tr><tr>
 <td><a href="#writelines">writelines</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; w&#114;&#105;&#116;&#101; &#97; &#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115; &#116;&#111; &#116;&#104;&#101; &#102;&#105;&#108;&#101;.</td>
+<td>Public method to write a list of strings to the file.</td>
 </tr>
 </table>
 <hr /><hr />
 <a NAME="AsyncFile" ID="AsyncFile"></a>
 <h2>AsyncFile</h2>
 <p>
-&#67;&#108;&#97;&#115;&#115; w&#114;&#97;&#112;&#112;&#105;&#110;&#103; &#97; &#115;&#111;&#99;&#107;&#101;&#116; &#111;&#98;&#106;&#101;&#99;&#116; w&#105;&#116;&#104; &#97; &#102;&#105;&#108;&#101; &#105;&#110;&#116;&#101;&#114;&#102;&#97;&#99;&#101;.
+Class wrapping a socket object with a file interface.
 </p>
 <h3>Derived from</h3>
 None
@@ -104,53 +104,53 @@
 <table>
 <tr>
 <td><a href="#AsyncFile.checkMode">checkMode</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#116;&#104;&#101; &#109;&#111;&#100;&#101;.</td>
+<td>Private method to check the mode.</td>
 </tr><tr>
 <td><a href="#AsyncFile.initialize">initialize</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#AsyncFile.nWrite">nWrite</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; w&#114;&#105;&#116;&#101; &#97; &#115;&#112;&#101;&#99;&#105;&#102;&#105;&#99; &#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#112;&#101;&#110;&#100;&#105;&#110;&#103; &#98;y&#116;&#101;&#115;.</td>
+<td>Private method to write a specific number of pending bytes.</td>
 </tr>
 </table>
 <a NAME="AsyncFile.checkMode" ID="AsyncFile.checkMode"></a>
 <h4>AsyncFile.checkMode</h4>
 <b>checkMode</b>(<i></i>)
 <p>
-&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#116;&#104;&#101; &#109;&#111;&#100;&#101;.
+Private method to check the mode.
 </p><p>
-&#84;&#104;&#105;&#115; &#109;&#101;&#116;&#104;&#111;&#100; &#99;&#104;&#101;&#99;&#107;&#115;, &#105;&#102; &#97;&#110; &#111;&#112;&#101;&#114;&#97;&#116;&#105;&#111;&#110; &#105;&#115; &#112;&#101;&#114;&#109;&#105;&#116;&#116;&#101;&#100; &#97;&#99;&#99;&#111;&#114;&#100;&#105;&#110;&#103; &#116;&#111;
-&#116;&#104;&#101; &#109;&#111;&#100;&#101; &#111;&#102; &#116;&#104;&#101; &#102;&#105;&#108;&#101;. &#73;&#102; &#105;&#116; &#105;&#115; &#110;&#111;&#116;, &#97;&#110; &#73;&#79;&#69;&#114;&#114;&#111;&#114; &#105;&#115; &#114;&#97;&#105;&#115;&#101;&#100;.
+This method checks, if an operation is permitted according to
+the mode of the file. If it is not, an IOError is raised.
 </p><dl>
 <dt><i>mode</i></dt>
 <dd>
-&#116;&#104;&#101; &#109;&#111;&#100;&#101; &#116;&#111; &#98;&#101; &#99;&#104;&#101;&#99;&#107;&#101;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;)
+the mode to be checked (string)
 </dd>
 </dl><a NAME="AsyncFile.initialize" ID="AsyncFile.initialize"></a>
 <h4>AsyncFile.initialize</h4>
 <b>initialize</b>(<i>mode, name</i>)
 <p>
-&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+Constructor
 </p><dl>
 <dt><i>sock</i></dt>
 <dd>
-&#116;&#104;&#101; &#115;&#111;&#99;&#107;&#101;&#116; &#111;&#98;&#106;&#101;&#99;&#116; &#98;&#101;&#105;&#110;&#103; w&#114;&#97;&#112;&#112;&#101;&#100;
+the socket object being wrapped
 </dd><dt><i>mode</i></dt>
 <dd>
-&#109;&#111;&#100;&#101; &#111;&#102; &#116;&#104;&#105;&#115; &#102;&#105;&#108;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
+mode of this file (string)
 </dd><dt><i>name</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#105;&#115; &#102;&#105;&#108;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
+name of this file (string)
 </dd>
 </dl><a NAME="AsyncFile.nWrite" ID="AsyncFile.nWrite"></a>
 <h4>AsyncFile.nWrite</h4>
 <b>nWrite</b>(<i></i>)
 <p>
-&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; w&#114;&#105;&#116;&#101; &#97; &#115;&#112;&#101;&#99;&#105;&#102;&#105;&#99; &#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#112;&#101;&#110;&#100;&#105;&#110;&#103; &#98;y&#116;&#101;&#115;.
+Private method to write a specific number of pending bytes.
 </p><dl>
 <dt><i>n</i></dt>
 <dd>
-&#116;&#104;&#101; &#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#98;y&#116;&#101;&#115; &#116;&#111; &#98;&#101; w&#114;&#105;&#116;&#116;&#101;&#110; (&#105;&#110;&#116;)
+the number of bytes to be written (int)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -159,11 +159,11 @@
 <h2><<</h2>
 <b><<</b>(<i>s</i>)
 <p>
-&#83;y&#110;&#111;&#110;y&#109; &#102;&#111;&#114; w&#114;&#105;&#116;&#101;(&#115;).
+Synonym for write(s).
 </p><dl>
 <dt><i>s</i></dt>
 <dd>
-&#98;y&#116;&#101;&#115; &#116;&#111; &#98;&#101; w&#114;&#105;&#116;&#116;&#101;&#110; (&#115;&#116;&#114;&#105;&#110;&#103;)
+bytes to be written (string)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -172,16 +172,16 @@
 <h2>AsyncPendingWrite</h2>
 <b>AsyncPendingWrite</b>(<i>file</i>)
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#102;&#111;&#114; &#100;&#97;&#116;&#97; &#116;&#111; &#98;&#101; w&#114;&#105;&#116;&#116;&#101;&#110;.
+Module function to check for data to be written.
 </p><dl>
 <dt><i>file</i></dt>
 <dd>
-&#84;&#104;&#101; &#102;&#105;&#108;&#101; &#111;&#98;&#106;&#101;&#99;&#116; &#116;&#111; &#98;&#101; &#99;&#104;&#101;&#99;&#107;&#101;&#100; (&#102;&#105;&#108;&#101;)
+The file object to be checked (file)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#70;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#105;&#102; &#116;&#104;&#101;&#114;&#101; &#105;&#115; &#100;&#97;&#116;&#97; w&#97;&#116;&#105;&#110;&#103; (&#105;&#110;&#116;)
+Flag indicating if there is data wating (int)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -190,7 +190,7 @@
 <h2>close</h2>
 <b>close</b>(<i></i>)
 <p>
-&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#108;&#111;&#115;&#101; &#116;&#104;&#101; &#102;&#105;&#108;&#101;.
+Public method to close the file.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
@@ -198,11 +198,11 @@
 <h2>fileno</h2>
 <b>fileno</b>(<i></i>)
 <p>
-&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#114;&#101;&#116;&#117;&#114;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#102;&#105;&#108;&#101; &#110;&#117;&#109;&#98;&#101;&#114;.
+Public method returning the file number.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#102;&#105;&#108;&#101; &#110;&#117;&#109;&#98;&#101;&#114; (&#105;&#110;&#116;)
+file number (int)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -211,7 +211,7 @@
 <h2>flush</h2>
 <b>flush</b>(<i></i>)
 <p>
-&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; w&#114;&#105;&#116;&#101; &#97;&#108;&#108; &#112;&#101;&#110;&#100;&#105;&#110;&#103; &#98;y&#116;&#101;&#115;.
+Public method to write all pending bytes.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
@@ -219,11 +219,11 @@
 <h2>getSock</h2>
 <b>getSock</b>(<i></i>)
 <p>
-&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#115;&#111;&#99;&#107;&#101;&#116; &#111;&#98;&#106;&#101;&#99;&#116;.
+Public method to get the socket object.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#116;&#104;&#101; &#115;&#111;&#99;&#107;&#101;&#116; &#111;&#98;&#106;&#101;&#99;&#116;
+the socket object
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -232,11 +232,11 @@
 <h2>isatty</h2>
 <b>isatty</b>(<i></i>)
 <p>
-&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#101; w&#104;&#101;&#116;&#104;&#101;&#114; &#97; &#116;&#116;y &#105;&#110;&#116;&#101;&#114;&#102;&#97;&#99;&#101; &#105;&#115; &#115;&#117;&#112;&#112;&#111;&#114;&#116;&#101;&#100;.
+Public method to indicate whether a tty interface is supported.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#97;&#108;w&#97;y&#115; &#102;&#97;&#108;&#115;&#101;
+always false
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -245,11 +245,11 @@
 <h2>pendingWrite</h2>
 <b>pendingWrite</b>(<i></i>)
 <p>
-&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#104;&#97;&#116; &#114;&#101;&#116;&#117;&#114;&#110;&#115; &#116;&#104;&#101; &#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#98;y&#116;&#101;&#115; w&#97;&#105;&#116;&#105;&#110;&#103; &#116;&#111; &#98;&#101; w&#114;&#105;&#116;&#116;&#101;&#110;.
+Public method that returns the number of bytes waiting to be written.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#116;&#104;&#101; &#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#98;y&#116;&#101;&#115; &#116;&#111; &#98;&#101; w&#114;&#105;&#116;&#116;&#101;&#110; (&#105;&#110;&#116;)
+the number of bytes to be written (int)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -258,16 +258,16 @@
 <h2>read</h2>
 <b>read</b>(<i>size = -1</i>)
 <p>
-&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#98;y&#116;&#101;&#115; &#102;&#114;&#111;&#109; &#116;&#104;&#105;&#115; &#102;&#105;&#108;&#101;.
+Public method to read bytes from this file.
 </p><dl>
 <dt><i>size</i></dt>
 <dd>
-&#109;&#97;x&#105;&#109;&#117;&#109; &#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#98;y&#116;&#101;&#115; &#116;&#111; &#98;&#101; &#114;&#101;&#97;&#100; (&#105;&#110;&#116;)
+maximum number of bytes to be read (int)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#116;&#104;&#101; &#98;y&#116;&#101;&#115; &#114;&#101;&#97;&#100; (&#97;&#110;y)
+the bytes read (any)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -276,19 +276,19 @@
 <h2>readline</h2>
 <b>readline</b>(<i>size = -1</i>)
 <p>
-&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#97; &#108;&#105;&#110;&#101; &#102;&#114;&#111;&#109; &#116;&#104;&#105;&#115; &#102;&#105;&#108;&#101;.
+Public method to read a line from this file.
 </p><p>
-&#60;&#98;&#62;&#78;&#111;&#116;&#101;&#60;/&#98;&#62;&#58; &#84;&#104;&#105;&#115; &#109;&#101;&#116;&#104;&#111;&#100; w&#105;&#108;&#108; &#110;&#111;&#116; &#98;&#108;&#111;&#99;&#107; &#97;&#110;&#100; &#109;&#97;y &#114;&#101;&#116;&#117;&#114;&#110;
-&#111;&#110;&#108;y &#97; &#112;&#97;&#114;&#116; &#111;&#102; &#97; &#108;&#105;&#110;&#101; &#105;&#102; &#116;&#104;&#97;&#116; &#105;&#115; &#97;&#108;&#108; &#116;&#104;&#97;&#116; &#105;&#115; &#97;v&#97;&#105;&#108;&#97;&#98;&#108;&#101;.
+<b>Note</b>: This method will not block and may return
+only a part of a line if that is all that is available.
 </p><dl>
 <dt><i>size</i></dt>
 <dd>
-&#109;&#97;x&#105;&#109;&#117;&#109; &#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#98;y&#116;&#101;&#115; &#116;&#111; &#98;&#101; &#114;&#101;&#97;&#100; (&#105;&#110;&#116;)
+maximum number of bytes to be read (int)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#111;&#110;&#101; &#108;&#105;&#110;&#101; &#111;&#102; &#116;&#101;x&#116; &#117;&#112; &#116;&#111; &#115;&#105;z&#101; &#98;y&#116;&#101;&#115; (&#115;&#116;&#114;&#105;&#110;&#103;)
+one line of text up to size bytes (string)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -297,16 +297,16 @@
 <h2>readlines</h2>
 <b>readlines</b>(<i>sizehint = -1</i>)
 <p>
-&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#97;&#108;&#108; &#108;&#105;&#110;&#101;&#115; &#102;&#114;&#111;&#109; &#116;&#104;&#105;&#115; &#102;&#105;&#108;&#101;.
+Public method to read all lines from this file.
 </p><dl>
 <dt><i>sizehint</i></dt>
 <dd>
-&#104;&#105;&#110;&#116; &#111;&#102; &#116;&#104;&#101; &#110;&#117;&#109;&#98;&#101;&#114;&#115; &#111;&#102; &#98;y&#116;&#101;&#115; &#116;&#111; &#98;&#101; &#114;&#101;&#97;&#100; (&#105;&#110;&#116;)
+hint of the numbers of bytes to be read (int)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#108;&#105;&#115;&#116; &#111;&#102; &#108;&#105;&#110;&#101;&#115; &#114;&#101;&#97;&#100; (&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;)
+list of lines read (list of strings)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -315,12 +315,12 @@
 <h2>seek</h2>
 <b>seek</b>(<i>offset, whence=IO::SEEK_SET</i>)
 <p>
-&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#109;&#111;v&#101; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#112;&#111;&#105;&#110;&#116;&#101;&#114;.
+Public method to move the filepointer.
 </p><dl>
 <dt>Raises <b>IOError</b>:</dt>
 <dd>
-&#84;&#104;&#105;&#115; &#109;&#101;&#116;&#104;&#111;&#100; &#105;&#115; &#110;&#111;&#116; &#115;&#117;&#112;&#112;&#111;&#114;&#116;&#101;&#100; &#97;&#110;&#100; &#97;&#108;w&#97;y&#115; &#114;&#97;&#105;&#115;&#101;&#115; &#97;&#110;
-       &#73;&#79;&#69;&#114;&#114;&#111;&#114;.
+This method is not supported and always raises an
+       IOError.
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -329,12 +329,12 @@
 <h2>tell</h2>
 <b>tell</b>(<i></i>)
 <p>
-&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#112;&#111;&#105;&#110;&#116;&#101;&#114; &#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110;.
+Public method to get the filepointer position.
 </p><dl>
 <dt>Raises <b>IOError</b>:</dt>
 <dd>
-&#84;&#104;&#105;&#115; &#109;&#101;&#116;&#104;&#111;&#100; &#105;&#115; &#110;&#111;&#116; &#115;&#117;&#112;&#112;&#111;&#114;&#116;&#101;&#100; &#97;&#110;&#100; &#97;&#108;w&#97;y&#115; &#114;&#97;&#105;&#115;&#101;&#115; &#97;&#110;
-      &#73;&#79;&#69;&#114;&#114;&#111;&#114;.
+This method is not supported and always raises an
+      IOError.
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -343,11 +343,11 @@
 <h2>write</h2>
 <b>write</b>(<i>s</i>)
 <p>
-&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; w&#114;&#105;&#116;&#101; &#97; &#115;&#116;&#114;&#105;&#110;&#103; &#116;&#111; &#116;&#104;&#101; &#102;&#105;&#108;&#101;.
+Public method to write a string to the file.
 </p><dl>
 <dt><i>s</i></dt>
 <dd>
-&#98;y&#116;&#101;&#115; &#116;&#111; &#98;&#101; w&#114;&#105;&#116;&#116;&#101;&#110; (&#115;&#116;&#114;&#105;&#110;&#103;)
+bytes to be written (string)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -356,11 +356,11 @@
 <h2>writelines</h2>
 <b>writelines</b>(<i>list</i>)
 <p>
-&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; w&#114;&#105;&#116;&#101; &#97; &#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115; &#116;&#111; &#116;&#104;&#101; &#102;&#105;&#108;&#101;.
+Public method to write a list of strings to the file.
 </p><dl>
 <dt><i>list</i></dt>
 <dd>
-&#116;&#104;&#101; &#108;&#105;&#115;&#116; &#116;&#111; &#98;&#101; w&#114;&#105;&#116;&#116;&#101;&#110; (&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;)
+the list to be written (list of string)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

Mercurial Repository: eric

eric ide

mercurial