Bitcoin Core  0.15.99
P2P Digital Currency
Public Member Functions | Private Attributes | List of all members
CAutoFile Class Reference

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

#include <streams.h>

Public Member Functions

 CAutoFile (FILE *filenew, int nTypeIn, int nVersionIn)
 
 ~CAutoFile ()
 
 CAutoFile (const CAutoFile &)=delete
 
CAutoFileoperator= (const CAutoFile &)=delete
 
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 nullptr, false otherwise. More...
 
int GetType () const
 
int GetVersion () const
 
void read (char *pch, size_t nSize)
 
void ignore (size_t nSize)
 
void write (const char *pch, size_t nSize)
 
template<typename T >
CAutoFileoperator<< (const T &obj)
 
template<typename T >
CAutoFileoperator>> (T &obj)
 

Private Attributes

const int nType
 
const 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 453 of file streams.h.

Constructor & Destructor Documentation

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

Definition at line 462 of file streams.h.

CAutoFile::~CAutoFile ( )
inline

Definition at line 467 of file streams.h.

CAutoFile::CAutoFile ( const CAutoFile )
delete

Member Function Documentation

void CAutoFile::fclose ( )
inline

Definition at line 476 of file streams.h.

Here is the caller graph for this function:

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 494 of file streams.h.

Here is the caller graph for this function:

int CAutoFile::GetType ( ) const
inline

Definition at line 503 of file streams.h.

int CAutoFile::GetVersion ( ) const
inline

Definition at line 504 of file streams.h.

void CAutoFile::ignore ( size_t  nSize)
inline

Definition at line 514 of file streams.h.

bool CAutoFile::IsNull ( ) const
inline

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

Definition at line 498 of file streams.h.

Here is the caller graph for this function:

template<typename T >
CAutoFile& CAutoFile::operator<< ( const T &  obj)
inline

Definition at line 536 of file streams.h.

Here is the call graph for this function:

CAutoFile& CAutoFile::operator= ( const CAutoFile )
delete
template<typename T >
CAutoFile& CAutoFile::operator>> ( T &  obj)
inline

Definition at line 546 of file streams.h.

Here is the call graph for this function:

void CAutoFile::read ( char *  pch,
size_t  nSize 
)
inline

Definition at line 506 of file streams.h.

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 488 of file streams.h.

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

Definition at line 527 of file streams.h.

Member Data Documentation

FILE* CAutoFile::file
private

Definition at line 459 of file streams.h.

const int CAutoFile::nType
private

Definition at line 456 of file streams.h.

const int CAutoFile::nVersion
private

Definition at line 457 of file streams.h.


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