1 /*---------------------------------------------------------------------------*
2   Project:  Horizon
3   File:     fs_FileStream.h
4 
5   Copyright (C)2009-2012 Nintendo Co., Ltd.  All rights reserved.
6 
7   These coded instructions, statements, and computer programs contain
8   proprietary information of Nintendo of America Inc. and/or Nintendo
9   Company Ltd., and are protected by Federal copyright law.  They may
10   not be disclosed to third parties or copied or duplicated in any form,
11   in whole or in part, without the prior written consent of Nintendo.
12 
13   $Rev: 46347 $
14  *---------------------------------------------------------------------------*/
15 
16 #ifndef NN_FS_FS_FILESTREAM_H_
17 #define NN_FS_FS_FILESTREAM_H_
18 
19 #include <nn/fs/fs_IStream.h>
20 #include <nn/fs/fs_FileBase.h>
21 #include <nn/fnd/fnd_Storage.h>
22 
23 namespace nn { namespace fs {
24 
25 /* Please see man pages for details
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 class FileStream : public IStream, public detail::FileBase, private nn::util::NonCopyable<FileStream>
54 {
55 public:
56 
57     /* Please see man pages for details
58 
59 
60 
61 
62 
63     */
FileStream()64     FileStream() {}
65 
66     /* Please see man pages for details
67 
68 
69 
70 
71 
72 
73 
74 
75 
76     */
FileStream(const wchar_t * pathName,bit32 openMode)77     FileStream(const wchar_t* pathName, bit32 openMode) : detail::FileBase(pathName, openMode) {}
78 
79     /* Please see man pages for details
80 
81 
82 
83 
84 
85 
86 
87 
88 
89 
90 
91 
92     */
FileStream(const char * pathName,bit32 openMode)93     FileStream(const char* pathName, bit32 openMode) : detail::FileBase(pathName, openMode) {}
94 
95     /* Please see man pages for details
96 
97 
98 
99 
100 
101 
102 
103 
104 
105 
106 
107     */
Initialize(const wchar_t * pathName,bit32 openMode)108     void Initialize(const wchar_t* pathName, bit32 openMode) { detail::FileBase::Initialize(pathName, openMode); }
109 
110     /* Please see man pages for details
111 
112 
113 
114 
115 
116 
117 
118 
119 
120 
121 
122 
123 
124 
125     */
Initialize(const char * pathName,bit32 openMode)126     void Initialize(const char* pathName, bit32 openMode) { detail::FileBase::Initialize(pathName, openMode); }
127 
128     /* Please see man pages for details
129 
130 
131 
132 
133 
134 
135 
136 
137 
138 
139 
140 
141 
142 
143 
144     */
TryInitialize(const wchar_t * pathName,bit32 openMode)145     nn::Result TryInitialize(const wchar_t* pathName, bit32 openMode) { return detail::FileBase::TryInitialize(pathName, openMode); }
146 
147     /* Please see man pages for details
148 
149 
150 
151 
152 
153 
154 
155 
156 
157 
158 
159 
160 
161 
162 
163 
164 
165 
166     */
TryInitialize(const char * pathName,bit32 openMode)167     nn::Result TryInitialize(const char* pathName, bit32 openMode) { return detail::FileBase::TryInitialize(pathName, openMode); }
168 
169     /* Please see man pages for details
170 
171 
172 
173 
174 
175 
176     */
Finalize()177     void Finalize() { detail::FileBase::Finalize(); }
178 
179     /* Please see man pages for details
180 
181 
182 
183 
184 
185 
186     */
~FileStream()187     virtual ~FileStream() {}
188 
189     /* Please see man pages for details
190 
191 
192 
193 
194 
195 
196 
197 
198 
199 
200 
201     */
Read(void * buffer,size_t size)202     virtual s32 Read(void* buffer, size_t size) { return detail::FileBase::Read(buffer, size); }
203 
204     /* Please see man pages for details
205 
206 
207 
208 
209 
210 
211 
212 
213 
214 
215 
216 
217     */
TryRead(s32 * pOut,void * buffer,size_t size)218     virtual Result TryRead(s32* pOut, void* buffer, size_t size) { return detail::FileBase::TryRead(pOut, buffer, size); }
219 
220     /* Please see man pages for details
221 
222 
223 
224 
225 
226 
227 
228 
229 
230 
231 
232 
233 
234 
235 
236 
237 
238 
239     */
Write(const void * buffer,size_t size,bool flush)240     virtual s32 Write(const void* buffer, size_t size, bool flush) { return detail::FileBase::Write(buffer, size, flush); }
241 
242     /* Please see man pages for details
243 
244 
245 
246 
247 
248 
249 
250 
251 
252 
253 
254 
255 
256 
257 
258 
259 
260 
261 
262     */
TryWrite(s32 * pOut,const void * buffer,size_t size,bool flush)263     virtual Result TryWrite(s32* pOut, const void* buffer, size_t size, bool flush) { return detail::FileBase::TryWrite(pOut, buffer, size, flush); }
264 
265     /* Please see man pages for details
266 
267 
268 
269 
270 
271 
272     */
Seek(s64 position,PositionBase base)273     virtual void Seek(s64 position, PositionBase base) { detail::FileBase::Seek(position, base); }
274 
275     /* Please see man pages for details
276 
277 
278 
279 
280 
281 
282 
283 
284     */
TrySeek(s64 position,PositionBase base)285     virtual Result TrySeek(s64 position, PositionBase base) { return detail::FileBase::TrySeek(position, base); }
286 
287     /* Please see man pages for details
288 
289 
290 
291     */
GetPosition()292     virtual s64 GetPosition() const { return detail::FileBase::GetPosition(); }
293 
294     /* Please see man pages for details
295 
296 
297 
298 
299 
300     */
TryGetPosition(s64 * pOut)301     virtual Result TryGetPosition(s64* pOut) const { return detail::FileBase::TryGetPosition(pOut); }
302 
303     /* Please see man pages for details
304 
305 
306 
307     */
SetPosition(s64 position)308     virtual void SetPosition(s64 position) { detail::FileBase::SetPosition(position); }
309 
310     /* Please see man pages for details
311 
312 
313 
314 
315 
316     */
TrySetPosition(s64 position)317     virtual Result TrySetPosition(s64 position) { return detail::FileBase::TrySetPosition(position); }
318 
319     /* Please see man pages for details
320 
321 
322 
323     */
GetSize()324     virtual s64 GetSize() const { return detail::FileBase::GetSize(); }
325 
326     /* Please see man pages for details
327 
328 
329 
330 
331 
332     */
TryGetSize(s64 * pOut)333     virtual Result TryGetSize(s64* pOut) const { return detail::FileBase::TryGetSize(pOut); }
334 
335     /* Please see man pages for details
336 
337 
338 
339      */
SetSize(s64 size)340     virtual void SetSize(s64 size) { detail::FileBase::SetSize(size); }
341 
342     /* Please see man pages for details
343 
344 
345 
346 
347 
348      */
TrySetSize(s64 size)349     virtual Result TrySetSize(s64 size) { return detail::FileBase::TrySetSize(size); }
350 
351     /* Please see man pages for details
352 
353      */
Flush()354     virtual void Flush() { detail::FileBase::Flush(); }
355 
356     /* Please see man pages for details
357 
358 
359 
360      */
TryFlush()361     virtual Result TryFlush() { return detail::FileBase::TryFlush(); }
362 
363     /* Please see man pages for details
364 
365 
366 
367 
368 
369 
370 
371     */
SetPriority(s32 priority)372     void SetPriority(s32 priority) { detail::FileBase::SetPriority(priority); }
373 
374     /* Please see man pages for details
375 
376 
377 
378 
379 
380 
381 
382 
383 
384     */
TrySetPriority(s32 priority)385     Result TrySetPriority(s32 priority) { return detail::FileBase::TrySetPriority(priority); }
386 
387 
388     /* Please see man pages for details
389 
390 
391 
392 
393 
394 
395 
396 
397     */
GetPriority(s32 * pOut)398     void GetPriority(s32* pOut) const { detail::FileBase::GetPriority(pOut); }
399 
400     /* Please see man pages for details
401 
402 
403 
404 
405 
406 
407 
408 
409 
410 
411     */
TryGetPriority(s32 * pOut)412     Result TryGetPriority(s32* pOut) const { return detail::FileBase::TryGetPriority(pOut); }
413 };
414 
415 }}
416 
417 #endif
418