Mercurial Repositories > eric / file comparison

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

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

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
equal deleted inserted replaced
57:81326a94fdca 58:37f0444c3479
20 </style> 20 </style>
21 </head> 21 </head>
22 <body><a NAME="top" ID="top"></a> 22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.DebugClients.Ruby.AsyncFile</h1> 23 <h1>eric5.DebugClients.Ruby.AsyncFile</h1>
24 <p> 24 <p>
25 &#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;. 25 File implementing an asynchronous file like socket interface for the debugger.
26 </p> 26 </p>
27 <h3>Global Attributes</h3> 27 <h3>Global Attributes</h3>
28 <table> 28 <table>
29 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
30 </table> 30 </table>
31 <h3>Classes</h3> 31 <h3>Classes</h3>
32 <table> 32 <table>
33 <tr> 33 <tr>
34 <td><a href="#AsyncFile">AsyncFile</a></td> 34 <td><a href="#AsyncFile">AsyncFile</a></td>
35 <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> 35 <td>Class wrapping a socket object with a file interface.</td>
36 </tr> 36 </tr>
37 </table> 37 </table>
38 <h3>Modules</h3> 38 <h3>Modules</h3>
39 <table> 39 <table>
40 <tr><td>None</td></tr> 40 <tr><td>None</td></tr>
41 </table> 41 </table>
42 <h3>Functions</h3> 42 <h3>Functions</h3>
43 <table> 43 <table>
44 <tr> 44 <tr>
45 <td><a href="#<<"><<</a></td> 45 <td><a href="#<<"><<</a></td>
46 <td>&#83;y&#110;&#111;&#110;y&#109; &#102;&#111;&#114; w&#114;&#105;&#116;&#101;(&#115;).</td> 46 <td>Synonym for write(s).</td>
47 </tr><tr> 47 </tr><tr>
48 <td><a href="#AsyncPendingWrite">AsyncPendingWrite</a></td> 48 <td><a href="#AsyncPendingWrite">AsyncPendingWrite</a></td>
49 <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> 49 <td>Module function to check for data to be written.</td>
50 </tr><tr> 50 </tr><tr>
51 <td><a href="#close">close</a></td> 51 <td><a href="#close">close</a></td>
52 <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> 52 <td>Public method to close the file.</td>
53 </tr><tr> 53 </tr><tr>
54 <td><a href="#fileno">fileno</a></td> 54 <td><a href="#fileno">fileno</a></td>
55 <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> 55 <td>Public method returning the file number.</td>
56 </tr><tr> 56 </tr><tr>
57 <td><a href="#flush">flush</a></td> 57 <td><a href="#flush">flush</a></td>
58 <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> 58 <td>Public method to write all pending bytes.</td>
59 </tr><tr> 59 </tr><tr>
60 <td><a href="#getSock">getSock</a></td> 60 <td><a href="#getSock">getSock</a></td>
61 <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> 61 <td>Public method to get the socket object.</td>
62 </tr><tr> 62 </tr><tr>
63 <td><a href="#isatty">isatty</a></td> 63 <td><a href="#isatty">isatty</a></td>
64 <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> 64 <td>Public method to indicate whether a tty interface is supported.</td>
65 </tr><tr> 65 </tr><tr>
66 <td><a href="#pendingWrite">pendingWrite</a></td> 66 <td><a href="#pendingWrite">pendingWrite</a></td>
67 <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> 67 <td>Public method that returns the number of bytes waiting to be written.</td>
68 </tr><tr> 68 </tr><tr>
69 <td><a href="#read">read</a></td> 69 <td><a href="#read">read</a></td>
70 <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> 70 <td>Public method to read bytes from this file.</td>
71 </tr><tr> 71 </tr><tr>
72 <td><a href="#readline">readline</a></td> 72 <td><a href="#readline">readline</a></td>
73 <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> 73 <td>Public method to read a line from this file.</td>
74 </tr><tr> 74 </tr><tr>
75 <td><a href="#readlines">readlines</a></td> 75 <td><a href="#readlines">readlines</a></td>
76 <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> 76 <td>Public method to read all lines from this file.</td>
77 </tr><tr> 77 </tr><tr>
78 <td><a href="#seek">seek</a></td> 78 <td><a href="#seek">seek</a></td>
79 <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> 79 <td>Public method to move the filepointer.</td>
80 </tr><tr> 80 </tr><tr>
81 <td><a href="#tell">tell</a></td> 81 <td><a href="#tell">tell</a></td>
82 <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> 82 <td>Public method to get the filepointer position.</td>
83 </tr><tr> 83 </tr><tr>
84 <td><a href="#write">write</a></td> 84 <td><a href="#write">write</a></td>
85 <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> 85 <td>Public method to write a string to the file.</td>
86 </tr><tr> 86 </tr><tr>
87 <td><a href="#writelines">writelines</a></td> 87 <td><a href="#writelines">writelines</a></td>
88 <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> 88 <td>Public method to write a list of strings to the file.</td>
89 </tr> 89 </tr>
90 </table> 90 </table>
91 <hr /><hr /> 91 <hr /><hr />
92 <a NAME="AsyncFile" ID="AsyncFile"></a> 92 <a NAME="AsyncFile" ID="AsyncFile"></a>
93 <h2>AsyncFile</h2> 93 <h2>AsyncFile</h2>
94 <p> 94 <p>
95 &#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;. 95 Class wrapping a socket object with a file interface.
96 </p> 96 </p>
97 <h3>Derived from</h3> 97 <h3>Derived from</h3>
98 None 98 None
99 <h3>Class Attributes</h3> 99 <h3>Class Attributes</h3>
100 <table> 100 <table>
102 </table> 102 </table>
103 <h3>Methods</h3> 103 <h3>Methods</h3>
104 <table> 104 <table>
105 <tr> 105 <tr>
106 <td><a href="#AsyncFile.checkMode">checkMode</a></td> 106 <td><a href="#AsyncFile.checkMode">checkMode</a></td>
107 <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> 107 <td>Private method to check the mode.</td>
108 </tr><tr> 108 </tr><tr>
109 <td><a href="#AsyncFile.initialize">initialize</a></td> 109 <td><a href="#AsyncFile.initialize">initialize</a></td>
110 <td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td> 110 <td>Constructor</td>
111 </tr><tr> 111 </tr><tr>
112 <td><a href="#AsyncFile.nWrite">nWrite</a></td> 112 <td><a href="#AsyncFile.nWrite">nWrite</a></td>
113 <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> 113 <td>Private method to write a specific number of pending bytes.</td>
114 </tr> 114 </tr>
115 </table> 115 </table>
116 <a NAME="AsyncFile.checkMode" ID="AsyncFile.checkMode"></a> 116 <a NAME="AsyncFile.checkMode" ID="AsyncFile.checkMode"></a>
117 <h4>AsyncFile.checkMode</h4> 117 <h4>AsyncFile.checkMode</h4>
118 <b>checkMode</b>(<i></i>) 118 <b>checkMode</b>(<i></i>)
119 <p> 119 <p>
120 &#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;. 120 Private method to check the mode.
121 </p><p> 121 </p><p>
122 &#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; 122 This method checks, if an operation is permitted according to
123 &#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;. 123 the mode of the file. If it is not, an IOError is raised.
124 </p><dl> 124 </p><dl>
125 <dt><i>mode</i></dt> 125 <dt><i>mode</i></dt>
126 <dd> 126 <dd>
127 &#116;&#104;&#101; &#109;&#111;&#100;&#101; &#116;&#111; &#98;&#101; &#99;&#104;&#101;&#99;&#107;&#101;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;) 127 the mode to be checked (string)
128 </dd> 128 </dd>
129 </dl><a NAME="AsyncFile.initialize" ID="AsyncFile.initialize"></a> 129 </dl><a NAME="AsyncFile.initialize" ID="AsyncFile.initialize"></a>
130 <h4>AsyncFile.initialize</h4> 130 <h4>AsyncFile.initialize</h4>
131 <b>initialize</b>(<i>mode, name</i>) 131 <b>initialize</b>(<i>mode, name</i>)
132 <p> 132 <p>
133 &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114; 133 Constructor
134 </p><dl> 134 </p><dl>
135 <dt><i>sock</i></dt> 135 <dt><i>sock</i></dt>
136 <dd> 136 <dd>
137 &#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; 137 the socket object being wrapped
138 </dd><dt><i>mode</i></dt> 138 </dd><dt><i>mode</i></dt>
139 <dd> 139 <dd>
140 &#109;&#111;&#100;&#101; &#111;&#102; &#116;&#104;&#105;&#115; &#102;&#105;&#108;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;) 140 mode of this file (string)
141 </dd><dt><i>name</i></dt> 141 </dd><dt><i>name</i></dt>
142 <dd> 142 <dd>
143 &#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#105;&#115; &#102;&#105;&#108;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;) 143 name of this file (string)
144 </dd> 144 </dd>
145 </dl><a NAME="AsyncFile.nWrite" ID="AsyncFile.nWrite"></a> 145 </dl><a NAME="AsyncFile.nWrite" ID="AsyncFile.nWrite"></a>
146 <h4>AsyncFile.nWrite</h4> 146 <h4>AsyncFile.nWrite</h4>
147 <b>nWrite</b>(<i></i>) 147 <b>nWrite</b>(<i></i>)
148 <p> 148 <p>
149 &#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;. 149 Private method to write a specific number of pending bytes.
150 </p><dl> 150 </p><dl>
151 <dt><i>n</i></dt> 151 <dt><i>n</i></dt>
152 <dd> 152 <dd>
153 &#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;) 153 the number of bytes to be written (int)
154 </dd> 154 </dd>
155 </dl> 155 </dl>
156 <div align="right"><a href="#top">Up</a></div> 156 <div align="right"><a href="#top">Up</a></div>
157 <hr /><hr /> 157 <hr /><hr />
158 <a NAME="<<" ID="<<"></a> 158 <a NAME="<<" ID="<<"></a>
159 <h2><<</h2> 159 <h2><<</h2>
160 <b><<</b>(<i>s</i>) 160 <b><<</b>(<i>s</i>)
161 <p> 161 <p>
162 &#83;y&#110;&#111;&#110;y&#109; &#102;&#111;&#114; w&#114;&#105;&#116;&#101;(&#115;). 162 Synonym for write(s).
163 </p><dl> 163 </p><dl>
164 <dt><i>s</i></dt> 164 <dt><i>s</i></dt>
165 <dd> 165 <dd>
166 &#98;y&#116;&#101;&#115; &#116;&#111; &#98;&#101; w&#114;&#105;&#116;&#116;&#101;&#110; (&#115;&#116;&#114;&#105;&#110;&#103;) 166 bytes to be written (string)
167 </dd> 167 </dd>
168 </dl> 168 </dl>
169 <div align="right"><a href="#top">Up</a></div> 169 <div align="right"><a href="#top">Up</a></div>
170 <hr /><hr /> 170 <hr /><hr />
171 <a NAME="AsyncPendingWrite" ID="AsyncPendingWrite"></a> 171 <a NAME="AsyncPendingWrite" ID="AsyncPendingWrite"></a>
172 <h2>AsyncPendingWrite</h2> 172 <h2>AsyncPendingWrite</h2>
173 <b>AsyncPendingWrite</b>(<i>file</i>) 173 <b>AsyncPendingWrite</b>(<i>file</i>)
174 <p> 174 <p>
175 &#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;. 175 Module function to check for data to be written.
176 </p><dl> 176 </p><dl>
177 <dt><i>file</i></dt> 177 <dt><i>file</i></dt>
178 <dd> 178 <dd>
179 &#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;) 179 The file object to be checked (file)
180 </dd> 180 </dd>
181 </dl><dl> 181 </dl><dl>
182 <dt>Returns:</dt> 182 <dt>Returns:</dt>
183 <dd> 183 <dd>
184 &#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;) 184 Flag indicating if there is data wating (int)
185 </dd> 185 </dd>
186 </dl> 186 </dl>
187 <div align="right"><a href="#top">Up</a></div> 187 <div align="right"><a href="#top">Up</a></div>
188 <hr /><hr /> 188 <hr /><hr />
189 <a NAME="close" ID="close"></a> 189 <a NAME="close" ID="close"></a>
190 <h2>close</h2> 190 <h2>close</h2>
191 <b>close</b>(<i></i>) 191 <b>close</b>(<i></i>)
192 <p> 192 <p>
193 &#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;. 193 Public method to close the file.
194 </p> 194 </p>
195 <div align="right"><a href="#top">Up</a></div> 195 <div align="right"><a href="#top">Up</a></div>
196 <hr /><hr /> 196 <hr /><hr />
197 <a NAME="fileno" ID="fileno"></a> 197 <a NAME="fileno" ID="fileno"></a>
198 <h2>fileno</h2> 198 <h2>fileno</h2>
199 <b>fileno</b>(<i></i>) 199 <b>fileno</b>(<i></i>)
200 <p> 200 <p>
201 &#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;. 201 Public method returning the file number.
202 </p><dl> 202 </p><dl>
203 <dt>Returns:</dt> 203 <dt>Returns:</dt>
204 <dd> 204 <dd>
205 &#102;&#105;&#108;&#101; &#110;&#117;&#109;&#98;&#101;&#114; (&#105;&#110;&#116;) 205 file number (int)
206 </dd> 206 </dd>
207 </dl> 207 </dl>
208 <div align="right"><a href="#top">Up</a></div> 208 <div align="right"><a href="#top">Up</a></div>
209 <hr /><hr /> 209 <hr /><hr />
210 <a NAME="flush" ID="flush"></a> 210 <a NAME="flush" ID="flush"></a>
211 <h2>flush</h2> 211 <h2>flush</h2>
212 <b>flush</b>(<i></i>) 212 <b>flush</b>(<i></i>)
213 <p> 213 <p>
214 &#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;. 214 Public method to write all pending bytes.
215 </p> 215 </p>
216 <div align="right"><a href="#top">Up</a></div> 216 <div align="right"><a href="#top">Up</a></div>
217 <hr /><hr /> 217 <hr /><hr />
218 <a NAME="getSock" ID="getSock"></a> 218 <a NAME="getSock" ID="getSock"></a>
219 <h2>getSock</h2> 219 <h2>getSock</h2>
220 <b>getSock</b>(<i></i>) 220 <b>getSock</b>(<i></i>)
221 <p> 221 <p>
222 &#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;. 222 Public method to get the socket object.
223 </p><dl> 223 </p><dl>
224 <dt>Returns:</dt> 224 <dt>Returns:</dt>
225 <dd> 225 <dd>
226 &#116;&#104;&#101; &#115;&#111;&#99;&#107;&#101;&#116; &#111;&#98;&#106;&#101;&#99;&#116; 226 the socket object
227 </dd> 227 </dd>
228 </dl> 228 </dl>
229 <div align="right"><a href="#top">Up</a></div> 229 <div align="right"><a href="#top">Up</a></div>
230 <hr /><hr /> 230 <hr /><hr />
231 <a NAME="isatty" ID="isatty"></a> 231 <a NAME="isatty" ID="isatty"></a>
232 <h2>isatty</h2> 232 <h2>isatty</h2>
233 <b>isatty</b>(<i></i>) 233 <b>isatty</b>(<i></i>)
234 <p> 234 <p>
235 &#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;. 235 Public method to indicate whether a tty interface is supported.
236 </p><dl> 236 </p><dl>
237 <dt>Returns:</dt> 237 <dt>Returns:</dt>
238 <dd> 238 <dd>
239 &#97;&#108;w&#97;y&#115; &#102;&#97;&#108;&#115;&#101; 239 always false
240 </dd> 240 </dd>
241 </dl> 241 </dl>
242 <div align="right"><a href="#top">Up</a></div> 242 <div align="right"><a href="#top">Up</a></div>
243 <hr /><hr /> 243 <hr /><hr />
244 <a NAME="pendingWrite" ID="pendingWrite"></a> 244 <a NAME="pendingWrite" ID="pendingWrite"></a>
245 <h2>pendingWrite</h2> 245 <h2>pendingWrite</h2>
246 <b>pendingWrite</b>(<i></i>) 246 <b>pendingWrite</b>(<i></i>)
247 <p> 247 <p>
248 &#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;. 248 Public method that returns the number of bytes waiting to be written.
249 </p><dl> 249 </p><dl>
250 <dt>Returns:</dt> 250 <dt>Returns:</dt>
251 <dd> 251 <dd>
252 &#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;) 252 the number of bytes to be written (int)
253 </dd> 253 </dd>
254 </dl> 254 </dl>
255 <div align="right"><a href="#top">Up</a></div> 255 <div align="right"><a href="#top">Up</a></div>
256 <hr /><hr /> 256 <hr /><hr />
257 <a NAME="read" ID="read"></a> 257 <a NAME="read" ID="read"></a>
258 <h2>read</h2> 258 <h2>read</h2>
259 <b>read</b>(<i>size = -1</i>) 259 <b>read</b>(<i>size = -1</i>)
260 <p> 260 <p>
261 &#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;. 261 Public method to read bytes from this file.
262 </p><dl> 262 </p><dl>
263 <dt><i>size</i></dt> 263 <dt><i>size</i></dt>
264 <dd> 264 <dd>
265 &#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;) 265 maximum number of bytes to be read (int)
266 </dd> 266 </dd>
267 </dl><dl> 267 </dl><dl>
268 <dt>Returns:</dt> 268 <dt>Returns:</dt>
269 <dd> 269 <dd>
270 &#116;&#104;&#101; &#98;y&#116;&#101;&#115; &#114;&#101;&#97;&#100; (&#97;&#110;y) 270 the bytes read (any)
271 </dd> 271 </dd>
272 </dl> 272 </dl>
273 <div align="right"><a href="#top">Up</a></div> 273 <div align="right"><a href="#top">Up</a></div>
274 <hr /><hr /> 274 <hr /><hr />
275 <a NAME="readline" ID="readline"></a> 275 <a NAME="readline" ID="readline"></a>
276 <h2>readline</h2> 276 <h2>readline</h2>
277 <b>readline</b>(<i>size = -1</i>) 277 <b>readline</b>(<i>size = -1</i>)
278 <p> 278 <p>
279 &#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;. 279 Public method to read a line from this file.
280 </p><p> 280 </p><p>
281 &#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; 281 <b>Note</b>: This method will not block and may return
282 &#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;. 282 only a part of a line if that is all that is available.
283 </p><dl> 283 </p><dl>
284 <dt><i>size</i></dt> 284 <dt><i>size</i></dt>
285 <dd> 285 <dd>
286 &#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;) 286 maximum number of bytes to be read (int)
287 </dd> 287 </dd>
288 </dl><dl> 288 </dl><dl>
289 <dt>Returns:</dt> 289 <dt>Returns:</dt>
290 <dd> 290 <dd>
291 &#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;) 291 one line of text up to size bytes (string)
292 </dd> 292 </dd>
293 </dl> 293 </dl>
294 <div align="right"><a href="#top">Up</a></div> 294 <div align="right"><a href="#top">Up</a></div>
295 <hr /><hr /> 295 <hr /><hr />
296 <a NAME="readlines" ID="readlines"></a> 296 <a NAME="readlines" ID="readlines"></a>
297 <h2>readlines</h2> 297 <h2>readlines</h2>
298 <b>readlines</b>(<i>sizehint = -1</i>) 298 <b>readlines</b>(<i>sizehint = -1</i>)
299 <p> 299 <p>
300 &#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;. 300 Public method to read all lines from this file.
301 </p><dl> 301 </p><dl>
302 <dt><i>sizehint</i></dt> 302 <dt><i>sizehint</i></dt>
303 <dd> 303 <dd>
304 &#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;) 304 hint of the numbers of bytes to be read (int)
305 </dd> 305 </dd>
306 </dl><dl> 306 </dl><dl>
307 <dt>Returns:</dt> 307 <dt>Returns:</dt>
308 <dd> 308 <dd>
309 &#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;) 309 list of lines read (list of strings)
310 </dd> 310 </dd>
311 </dl> 311 </dl>
312 <div align="right"><a href="#top">Up</a></div> 312 <div align="right"><a href="#top">Up</a></div>
313 <hr /><hr /> 313 <hr /><hr />
314 <a NAME="seek" ID="seek"></a> 314 <a NAME="seek" ID="seek"></a>
315 <h2>seek</h2> 315 <h2>seek</h2>
316 <b>seek</b>(<i>offset, whence=IO::SEEK_SET</i>) 316 <b>seek</b>(<i>offset, whence=IO::SEEK_SET</i>)
317 <p> 317 <p>
318 &#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;. 318 Public method to move the filepointer.
319 </p><dl> 319 </p><dl>
320 <dt>Raises <b>IOError</b>:</dt> 320 <dt>Raises <b>IOError</b>:</dt>
321 <dd> 321 <dd>
322 &#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; 322 This method is not supported and always raises an
323 &#73;&#79;&#69;&#114;&#114;&#111;&#114;. 323 IOError.
324 </dd> 324 </dd>
325 </dl> 325 </dl>
326 <div align="right"><a href="#top">Up</a></div> 326 <div align="right"><a href="#top">Up</a></div>
327 <hr /><hr /> 327 <hr /><hr />
328 <a NAME="tell" ID="tell"></a> 328 <a NAME="tell" ID="tell"></a>
329 <h2>tell</h2> 329 <h2>tell</h2>
330 <b>tell</b>(<i></i>) 330 <b>tell</b>(<i></i>)
331 <p> 331 <p>
332 &#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;. 332 Public method to get the filepointer position.
333 </p><dl> 333 </p><dl>
334 <dt>Raises <b>IOError</b>:</dt> 334 <dt>Raises <b>IOError</b>:</dt>
335 <dd> 335 <dd>
336 &#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; 336 This method is not supported and always raises an
337 &#73;&#79;&#69;&#114;&#114;&#111;&#114;. 337 IOError.
338 </dd> 338 </dd>
339 </dl> 339 </dl>
340 <div align="right"><a href="#top">Up</a></div> 340 <div align="right"><a href="#top">Up</a></div>
341 <hr /><hr /> 341 <hr /><hr />
342 <a NAME="write" ID="write"></a> 342 <a NAME="write" ID="write"></a>
343 <h2>write</h2> 343 <h2>write</h2>
344 <b>write</b>(<i>s</i>) 344 <b>write</b>(<i>s</i>)
345 <p> 345 <p>
346 &#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;. 346 Public method to write a string to the file.
347 </p><dl> 347 </p><dl>
348 <dt><i>s</i></dt> 348 <dt><i>s</i></dt>
349 <dd> 349 <dd>
350 &#98;y&#116;&#101;&#115; &#116;&#111; &#98;&#101; w&#114;&#105;&#116;&#116;&#101;&#110; (&#115;&#116;&#114;&#105;&#110;&#103;) 350 bytes to be written (string)
351 </dd> 351 </dd>
352 </dl> 352 </dl>
353 <div align="right"><a href="#top">Up</a></div> 353 <div align="right"><a href="#top">Up</a></div>
354 <hr /><hr /> 354 <hr /><hr />
355 <a NAME="writelines" ID="writelines"></a> 355 <a NAME="writelines" ID="writelines"></a>
356 <h2>writelines</h2> 356 <h2>writelines</h2>
357 <b>writelines</b>(<i>list</i>) 357 <b>writelines</b>(<i>list</i>)
358 <p> 358 <p>
359 &#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;. 359 Public method to write a list of strings to the file.
360 </p><dl> 360 </p><dl>
361 <dt><i>list</i></dt> 361 <dt><i>list</i></dt>
362 <dd> 362 <dd>
363 &#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;) 363 the list to be written (list of string)
364 </dd> 364 </dd>
365 </dl> 365 </dl>
366 <div align="right"><a href="#top">Up</a></div> 366 <div align="right"><a href="#top">Up</a></div>
367 <hr /> 367 <hr />
368 </body></html> 368 </body></html>

Mercurial Repository: eric

eric ide

mercurial