OLD | NEW |
1 /* Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 /* Copyright (c) 2012 The Chromium Authors. All rights reserved. |
2 * Use of this source code is governed by a BSD-style license that can be | 2 * Use of this source code is governed by a BSD-style license that can be |
3 * found in the LICENSE file. | 3 * found in the LICENSE file. |
4 */ | 4 */ |
5 | 5 |
6 | 6 |
7 /** | 7 /** |
8 * This file defines the API to create a file i/o object. | 8 * This file defines the API to create a file i/o object. |
9 */ | 9 */ |
10 | 10 |
(...skipping 136 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
147 * | 147 * |
148 * @param[in] file_io A <code>PP_Resource</code> corresponding to a file | 148 * @param[in] file_io A <code>PP_Resource</code> corresponding to a file |
149 * FileIO. | 149 * FileIO. |
150 * @param[in] offset The offset into the file. | 150 * @param[in] offset The offset into the file. |
151 * @param[in] buffer The buffer to hold the specified number of bytes read. | 151 * @param[in] buffer The buffer to hold the specified number of bytes read. |
152 * @param[in] bytes_to_read The number of bytes to read from | 152 * @param[in] bytes_to_read The number of bytes to read from |
153 * <code>offset</code>. | 153 * <code>offset</code>. |
154 * @param[in] callback A <code>PP_CompletionCallback</code> to be called upon | 154 * @param[in] callback A <code>PP_CompletionCallback</code> to be called upon |
155 * completion of Read(). | 155 * completion of Read(). |
156 * | 156 * |
157 * @return An The number of bytes read an error code from | 157 * @return An number of bytes read an error code from |
158 * <code>pp_errors.h</code>. If the return value is 0, then end-of-file was | 158 * <code>pp_errors.h</code>. If the return value is 0, then end-of-file was |
159 * reached. It is valid to call Read() multiple times with a completion | 159 * reached. It is valid to call Read() multiple times with a completion |
160 * callback to queue up parallel reads from the file, but pending reads | 160 * callback to queue up parallel reads from the file, but pending reads |
161 * cannot be interleaved with other operations. | 161 * cannot be interleaved with other operations. |
162 */ | 162 */ |
163 int32_t Read([in] PP_Resource file_io, | 163 int32_t Read([in] PP_Resource file_io, |
164 [in] int64_t offset, | 164 [in] int64_t offset, |
165 [inout] str_t buffer, | 165 [inout] str_t buffer, |
166 [in] int32_t bytes_to_read, | 166 [in] int32_t bytes_to_read, |
167 [in] PP_CompletionCallback callback); | 167 [in] PP_CompletionCallback callback); |
168 | 168 |
169 /** | 169 /** |
170 * Write() writes to an offset in the file. This function might perform a | 170 * Write() writes to an offset in the file. This function might perform a |
171 * partial write. The FileIO object must have been opened with write access. | 171 * partial write. The FileIO object must have been opened with write access. |
172 * | 172 * |
173 * @param[in] file_io A <code>PP_Resource</code> corresponding to a file | 173 * @param[in] file_io A <code>PP_Resource</code> corresponding to a file |
174 * FileIO. | 174 * FileIO. |
175 * @param[in] offset The offset into the file. | 175 * @param[in] offset The offset into the file. |
176 * @param[in] buffer The buffer to hold the specified number of bytes read. | 176 * @param[in] buffer The buffer to hold the specified number of bytes read. |
177 * @param[in] bytes_to_write The number of bytes to write to | 177 * @param[in] bytes_to_write The number of bytes to write to |
178 * <code>offset</code>. | 178 * <code>offset</code>. |
179 * @param[in] callback A <code>PP_CompletionCallback</code> to be called upon | 179 * @param[in] callback A <code>PP_CompletionCallback</code> to be called upon |
180 * completion of Write(). | 180 * completion of Write(). |
181 * | 181 * |
182 * @return An The number of bytes written or an error code from | 182 * @return The number of bytes written or an error code from |
183 * <code>pp_errors.h</code>. If the return value is 0, then end-of-file was | 183 * <code>pp_errors.h</code>. If the return value is 0, then end-of-file was |
184 * reached. It is valid to call Write() multiple times with a completion | 184 * reached. It is valid to call Write() multiple times with a completion |
185 * callback to queue up parallel writes to the file, but pending writes | 185 * callback to queue up parallel writes to the file, but pending writes |
186 * cannot be interleaved with other operations. | 186 * cannot be interleaved with other operations. |
187 */ | 187 */ |
188 int32_t Write([in] PP_Resource file_io, | 188 int32_t Write([in] PP_Resource file_io, |
189 [in] int64_t offset, | 189 [in] int64_t offset, |
190 [in] str_t buffer, | 190 [in] str_t buffer, |
191 [in] int32_t bytes_to_write, | 191 [in] int32_t bytes_to_write, |
192 [in] PP_CompletionCallback callback); | 192 [in] PP_CompletionCallback callback); |
(...skipping 42 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
235 * <strong>Note:</strong> If the FileIO object is destroyed, and it is still | 235 * <strong>Note:</strong> If the FileIO object is destroyed, and it is still |
236 * open, then it will be implicitly closed, so you are not required to call | 236 * open, then it will be implicitly closed, so you are not required to call |
237 * Close(). | 237 * Close(). |
238 * | 238 * |
239 * @param[in] file_io A <code>PP_Resource</code> corresponding to a file | 239 * @param[in] file_io A <code>PP_Resource</code> corresponding to a file |
240 * FileIO. | 240 * FileIO. |
241 */ | 241 */ |
242 void Close([in] PP_Resource file_io); | 242 void Close([in] PP_Resource file_io); |
243 }; | 243 }; |
244 | 244 |
OLD | NEW |