Pyrogenesis  13997
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Attributes | List of all members
CVFSFile Class Reference

Reads a file, then gives read-only access to the contents. More...

#include <Filesystem.h>

Public Member Functions

 CVFSFile ()
 
 ~CVFSFile ()
 
PSRETURN Load (const PIVFS &vfs, const VfsPath &filename)
 Returns either PSRETURN_OK or PSRETURN_CVFSFile_LoadFailed. More...
 
const u8GetBuffer () const
 Returns buffer of this file as a stream of bytes. More...
 
size_t GetBufferSize () const
 
CStr GetAsString () const
 Returns contents of file as a string. More...
 
CStr DecodeUTF8 () const
 Returns contents of a UTF-8 encoded file as a string with optional BOM removed. More...
 

Private Attributes

shared_ptr< u8m_Buffer
 
size_t m_BufferSize
 

Detailed Description

Reads a file, then gives read-only access to the contents.

Definition at line 69 of file Filesystem.h.

Constructor & Destructor Documentation

CVFSFile::CVFSFile ( )

Definition at line 108 of file Filesystem.cpp.

CVFSFile::~CVFSFile ( )

Definition at line 113 of file Filesystem.cpp.

Member Function Documentation

CStr CVFSFile::DecodeUTF8 ( ) const

Returns contents of a UTF-8 encoded file as a string with optional BOM removed.

Note
file must have been successfully loaded

Definition at line 153 of file Filesystem.cpp.

CStr CVFSFile::GetAsString ( ) const

Returns contents of file as a string.

Note
file must have been successfully loaded

Definition at line 148 of file Filesystem.cpp.

const u8 * CVFSFile::GetBuffer ( ) const

Returns buffer of this file as a stream of bytes.

Note
file must have been successfully loaded

Definition at line 138 of file Filesystem.cpp.

size_t CVFSFile::GetBufferSize ( ) const

Definition at line 143 of file Filesystem.cpp.

PSRETURN CVFSFile::Load ( const PIVFS vfs,
const VfsPath filename 
)

Returns either PSRETURN_OK or PSRETURN_CVFSFile_LoadFailed.

Note
Dies if the file has already been successfully loaded

Definition at line 117 of file Filesystem.cpp.

Member Data Documentation

shared_ptr<u8> CVFSFile::m_Buffer
private

Definition at line 101 of file Filesystem.h.

size_t CVFSFile::m_BufferSize
private

Definition at line 102 of file Filesystem.h.


The documentation for this class was generated from the following files: