CAutoFile Class Reference

Non-refcounted RAII wrapper for FILE*. More...

#include <streams.h>

Public Member Functions
	CAutoFile (FILE *filenew, int nTypeIn, int nVersionIn)
	~CAutoFile ()
void	fclose ()
FILE *	release ()
	Get wrapped FILE* with transfer of ownership. More...
FILE *	Get () const
	Get wrapped FILE* without transfer of ownership. More...
bool	IsNull () const
	Return true if the wrapped FILE* is NULL, false otherwise. More...
void	SetType (int n)
int	GetType ()
void	SetVersion (int n)
int	GetVersion ()
void	ReadVersion ()
void	WriteVersion ()
CAutoFile &	read (char *pch, size_t nSize)
CAutoFile &	ignore (size_t nSize)
CAutoFile &	write (const char *pch, size_t nSize)
template<typename T >
unsigned int	GetSerializeSize (const T &obj)
template<typename T >
CAutoFile &	operator<< (const T &obj)
template<typename T >
CAutoFile &	operator>> (T &obj)

Private Member Functions
	CAutoFile (const CAutoFile &)
CAutoFile &	operator= (const CAutoFile &)

Private Attributes
int	nType
int	nVersion
FILE *	file

Detailed Description

Non-refcounted RAII wrapper for FILE*.

Will automatically close the file when it goes out of scope if not null. If you're returning the file pointer, return file.release(). If you need to close the file early, use file.fclose() instead of fclose(file).

Definition at line 303 of file streams.h.

Constructor & Destructor Documentation

CAutoFile() [1/2]

CAutoFile::CAutoFile ( const CAutoFile &  )

private

CAutoFile() [2/2]

CAutoFile::CAutoFile ( FILE *  filenew, int  nTypeIn, int  nVersionIn  )

inline

Definition at line 316 of file streams.h.

~CAutoFile()

CAutoFile::~CAutoFile ( )

inline

Definition at line 323 of file streams.h.

Here is the call graph for this function:

Member Function Documentation

fclose()

void CAutoFile::fclose ( )

inline

Definition at line 328 of file streams.h.

Here is the caller graph for this function:

Get()

FILE* CAutoFile::Get ( ) const

inline

Get wrapped FILE* without transfer of ownership.

Note

Ownership of the FILE* will remain with this class. Use this only if the scope of the CAutoFile outlives use of the passed pointer.

Definition at line 351 of file streams.h.

GetSerializeSize()

template<typename T >

unsigned int CAutoFile::GetSerializeSize ( const T &  obj )

inline

Definition at line 400 of file streams.h.

Here is the call graph for this function:

GetType()

int CAutoFile::GetType ( )

inline

Definition at line 361 of file streams.h.

GetVersion()

int CAutoFile::GetVersion ( )

inline

Definition at line 363 of file streams.h.

ignore()

CAutoFile& CAutoFile::ignore ( size_t  nSize )

inline

Definition at line 376 of file streams.h.

IsNull()

bool CAutoFile::IsNull ( ) const

inline

Return true if the wrapped FILE* is NULL, false otherwise.

Definition at line 355 of file streams.h.

operator<<()

template<typename T >

CAutoFile& CAutoFile::operator<< ( const T &  obj )

inline

Definition at line 407 of file streams.h.

Here is the call graph for this function:

operator=()

CAutoFile& CAutoFile::operator= ( const CAutoFile &  )

private

operator>>()

template<typename T >

CAutoFile& CAutoFile::operator>> ( T &  obj )

inline

Definition at line 417 of file streams.h.

Here is the call graph for this function:

read()

CAutoFile& CAutoFile::read ( char *  pch, size_t  nSize  )

inline

Definition at line 367 of file streams.h.

ReadVersion()

void CAutoFile::ReadVersion ( )

inline

Definition at line 364 of file streams.h.

release()

FILE* CAutoFile::release ( )

inline

Get wrapped FILE* with transfer of ownership.

Note

This will invalidate the CAutoFile object, and makes it the responsibility of the caller of this function to clean up the returned FILE*.

Definition at line 340 of file streams.h.

SetType()

void CAutoFile::SetType ( int  n )

inline

Definition at line 360 of file streams.h.

SetVersion()

void CAutoFile::SetVersion ( int  n )

inline

Definition at line 362 of file streams.h.

write()

CAutoFile& CAutoFile::write ( const char *  pch, size_t  nSize  )

inline

Definition at line 390 of file streams.h.

WriteVersion()

void CAutoFile::WriteVersion ( )

inline

Definition at line 365 of file streams.h.

Member Data Documentation

file

FILE* CAutoFile::file

private

Definition at line 313 of file streams.h.

nType

int CAutoFile::nType

private

Definition at line 310 of file streams.h.

nVersion

int CAutoFile::nVersion

private

Definition at line 311 of file streams.h.

---

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

• src/streams.h