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

Constructor & Destructor Documentation

◆ CAutoFile() [1/2]

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

Definition at line 630 of file streams.h.

◆ ~CAutoFile()

CAutoFile::~CAutoFile ( )
inline

Definition at line 635 of file streams.h.

◆ CAutoFile() [2/2]

CAutoFile::CAutoFile ( const CAutoFile )
delete

Member Function Documentation

◆ fclose()

void CAutoFile::fclose ( )
inline

Definition at line 644 of file streams.h.

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

◆ GetType()

int CAutoFile::GetType ( ) const
inline

Definition at line 671 of file streams.h.

◆ GetVersion()

int CAutoFile::GetVersion ( ) const
inline

Definition at line 672 of file streams.h.

◆ ignore()

void CAutoFile::ignore ( size_t  nSize)
inline

Definition at line 682 of file streams.h.

◆ IsNull()

bool CAutoFile::IsNull ( ) const
inline

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

Definition at line 666 of file streams.h.

◆ operator<<()

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

Definition at line 704 of file streams.h.

Here is the call graph for this function:

◆ operator=()

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

◆ operator>>()

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

Definition at line 714 of file streams.h.

Here is the call graph for this function:

◆ read()

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

Definition at line 674 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 656 of file streams.h.

◆ write()

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

Definition at line 695 of file streams.h.

Member Data Documentation

◆ file

FILE* CAutoFile::file
private

Definition at line 627 of file streams.h.

◆ nType

const int CAutoFile::nType
private

Definition at line 624 of file streams.h.

◆ nVersion

const int CAutoFile::nVersion
private

Definition at line 625 of file streams.h.


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