1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-gnomevfs-handle">
<refnamediv>
<refname>gnomevfs.Handle</refname>
<refpurpose>Object representing an open file</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gnomevfs.Handle</classname></ooclass>
<constructorsynopsis language="python">
<methodname><link linkend="constructor-gnomevfs-handle">gnomevfs.Handle</link></methodname>
<methodparam><parameter role="keyword">uri</parameter></methodparam>
<methodparam><parameter role="keyword">open_mode</parameter><initializer>gnomevfs.OPEN_READ</initializer></methodparam>
</constructorsynopsis>
<methodsynopsis>
<methodname><link linkend="method-gnomevfs-handle--close">close</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis>
<methodname><link linkend="method-gnomevfs-handle--get_file_info">get_file_info</link></methodname>
<methodparam><parameter role="keyword">options</parameter><initializer>gnomevfs.FILE_INFO_DEFAULT</initializer></methodparam>
</methodsynopsis>
<methodsynopsis>
<methodname><link linkend="method-gnomevfs-handle--read">read</link></methodname>
<methodparam><parameter role="keyword">bytes</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<methodname><link linkend="method-gnomevfs-handle--seek">seek</link></methodname>
<methodparam><parameter role="keyword">offset</parameter></methodparam>
<methodparam><parameter role="keyword">whence</parameter><initializer>gnomevfs.SEEK_START</initializer></methodparam>
</methodsynopsis>
<methodsynopsis>
<methodname><link linkend="method-gnomevfs-handle--tell">tell</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis>
<methodname><link linkend="method-gnomevfs-handle--truncate">truncate</link></methodname>
<methodparam><parameter role="keyword">length</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<methodname><link linkend="method-gnomevfs-handle--write">write</link></methodname>
<methodparam><parameter role="keyword">buffer</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Description</title>
<para></para>
</refsect1>
<refsect1>
<title>Constructor</title>
<refsect2 id="constructor-gnomevfs-handle">
<programlisting>
<constructorsynopsis language="python">
<methodname><link linkend="constructor-gnomevfs-handle">gnomevfs.Handle</link></methodname>
<methodparam><parameter role="keyword">uri</parameter></methodparam>
<methodparam><parameter role="keyword">open_mode</parameter><initializer>gnomevfs.OPEN_READ</initializer></methodparam>
</constructorsynopsis>
</programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">uri</parameter>:</term>
<listitem><simpara>The URI to open.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">open_mode</parameter>:</term>
<listitem><simpara>Or'd set of <link linkend="gnomevfs-constants-openmode">open mode flags</link></simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis>:</term>
<listitem><simpara>the new <link linkend="class-gnomevfs-handle"><classname>gnomevfs.Handle</classname></link></simpara></listitem>
</varlistentry>
</variablelist>
<para></para>
</refsect2>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gnomevfs-handle--close">
<title>gnomevfs.Handle.close</title>
<programlisting>
<methodsynopsis language="python">
<methodname>close</methodname>
<methodparam></methodparam>
</methodsynopsis>
</programlisting>
<para>Close the file associated with this handle.</para>
</refsect2>
<refsect2 id="method-gnomevfs-handle--get_file_info">
<title>gnomevfs.Handle.get_file_info</title>
<programlisting>
<methodsynopsis language="python">
<methodname>get_file_info</methodname>
<methodparam><parameter role="keyword">options</parameter><initializer>gnomevfs.FILE_INFO_DEFAULT</initializer></methodparam>
</methodsynopsis>
</programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">options</parameter>:</term>
<listitem><simpara>Or'd set of <link linkend="gnomevfs-constants-fileinfo-options">file info options</link></simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis>:</term>
<listitem><simpara>A <link linkend="class-gnomevfs-fileinfo">gnomevfs.FileInfo</link>.</simpara></listitem>
</varlistentry>
</variablelist>
<para>Get information about the file, persuant to the options given.</para>
</refsect2>
<refsect2 id="method-gnomevfs-handle--read">
<title>gnomevfs.Handle.read</title>
<programlisting>
<methodsynopsis language="python">
<methodname>read</methodname>
<methodparam><parameter role="keyword">bytes</parameter></methodparam>
</methodsynopsis>
</programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">bytes</parameter>:</term>
<listitem><simpara>The number of bytes to read</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis>:</term>
<listitem><simpara>A string containing the data.</simpara></listitem>
</varlistentry>
</variablelist>
<para>Read <parameter role="keyword">bytes</parameter> from file. The actual number of bytes read may be less than this, so you may need to check the length of the string returned.</para>
</refsect2>
<refsect2 id="method-gnomevfs-handle--seek">
<title>gnomevfs.Handle.seek</title>
<programlisting>
<methodsynopsis language="python">
<methodname>seek</methodname>
<methodparam><parameter role="keyword">offset</parameter></methodparam>
<methodparam><parameter role="keyword">whence</parameter><initializer>gnomevfs.SEEK_START</initializer></methodparam>
</methodsynopsis>
</programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">offset</parameter>:</term>
<listitem><simpara>The number of bytes to offset from the position specified by <parameter role="keyword">whence</parameter>. This can be either positive or negative.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">whence</parameter>:</term>
<listitem><simpara>The <link linkend="gnomevfs-constants-seekmode">start position</link>.</simpara></listitem>
</varlistentry>
</variablelist>
<para>Set the current position for reading/writing.</para>
</refsect2>
<refsect2 id="method-gnomevfs-handle--tell">
<title>gnomevfs.Handle.tell</title>
<programlisting>
<methodsynopsis language="python">
<methodname>tell</methodname>
<methodparam></methodparam>
</methodsynopsis>
</programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis>:</term>
<listitem><simpara>A long specifying the current byte position.</simpara></listitem>
</varlistentry>
</variablelist>
<para>Returns the current position in the file. This is the position at which any reads or writes will begin at.</para>
</refsect2>
<refsect2 id="method-gnomevfs-handle--truncate">
<title>gnomevfs.Handle.truncate</title>
<programlisting>
<methodsynopsis language="python">
<methodname>truncate</methodname>
<methodparam><parameter role="keyword">length</parameter></methodparam>
</methodsynopsis>
</programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">length</parameter>:</term>
<listitem><simpara>The length to truncate to.</simpara></listitem>
</varlistentry>
</variablelist>
<para>Truncates the file to the length specified.</para>
</refsect2>
<refsect2 id="method-gnomevfs-handle--write">
<title>gnomevfs.Handle.write</title>
<programlisting>
<methodsynopsis language="python">
<methodname>write</methodname>
<methodparam><parameter role="keyword">buffer</parameter></methodparam>
</methodsynopsis>
</programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">buffer</parameter>:</term>
<listitem><simpara>The buffer to write to the file.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis>:</term>
<listitem><simpara>The number of bytes written.</simpara></listitem>
</varlistentry>
</variablelist>
<para>Write <parameter role="keyword">buffer</parameter> to the file. The number of bytes actually written may be less than the buffer, as is provided as the return value.</para>
</refsect2>
</refsect1>
</refentry>
|
