vae::core::fs::File Class Reference

#include <vae_fs.hpp>

Collaboration diagram for vae::core::fs::File:

Public Types
enum class	Mode { Read , Write , ReadWrite }

Public Member Functions
	File (const char *path, Mode mode=Mode::Read)
bool	valid () const
size_t	size ()
bool	readAll (char *dest)
	~File ()

Private Types
enum class	Seek { set = SEEK_SET , cur = SEEK_CUR , end = SEEK_END }

Private Attributes
void *	mHandle = nullptr
size_t	mSize = 0

Detailed Description

Definition at line 40 of file vae_fs.hpp.

Member Enumeration Documentation

Mode

enum class vae::core::fs::File::Mode

strong

Enumerator
Read
Write
ReadWrite

Definition at line 51 of file vae_fs.hpp.

                        {
            Read,
            Write,
            ReadWrite
        };

Seek

enum class vae::core::fs::File::Seek

strongprivate

Enumerator
set
cur
end

Definition at line 43 of file vae_fs.hpp.

                        {
    #ifdef VAE_NO_STDIO
            set = 0, cur, end
    #else
            set = SEEK_SET, cur = SEEK_CUR, end = SEEK_END
    #endif
        };

Constructor & Destructor Documentation

File()

vae::core::fs::File::File ( const char *  path, Mode  mode = Mode::Read  )

inline

Definition at line 57 of file vae_fs.hpp.

                                                     {
            const char* MODES[3] = { "r", "w", "rw" };
            mHandle = vae_file_open(path, MODES[(size_t) mode]);
            if (mHandle == 0) { return; }
            mSize = vae_file_seek(mHandle, 0L, (int) Seek::end);
            vae_file_seek(mHandle, 0L, (int) Seek::set);
        }

Here is the call graph for this function:

~File()

vae::core::fs::File::~File ( )

inline

Definition at line 77 of file vae_fs.hpp.

                {
            if (mHandle == nullptr) {return; }
            vae_file_close(mHandle);
        }

Here is the call graph for this function:

Member Function Documentation

readAll()

bool vae::core::fs::File::readAll ( char *  dest )

inline

Definition at line 72 of file vae_fs.hpp.

                                 {
            if (mHandle == nullptr) { return false; }
            return vae_file_read(dest, size(), 1, mHandle) == 1;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

size()

size_t vae::core::fs::File::size ( )

inline

Definition at line 67 of file vae_fs.hpp.

                      {
            if (mHandle == nullptr) { return 0; }
            return mSize;
        }

Here is the caller graph for this function:

valid()

bool vae::core::fs::File::valid ( ) const

inline

Definition at line 65 of file vae_fs.hpp.

{ return mHandle != nullptr; }

Member Data Documentation

mHandle

void* vae::core::fs::File::mHandle = nullptr

private

Definition at line 41 of file vae_fs.hpp.

mSize

size_t vae::core::fs::File::mSize = 0

private

Definition at line 42 of file vae_fs.hpp.

---

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

• vae_fs.hpp