Soldered SD Card Arduino Library 1.0.0
Easily read and write files to and form the SD card breakout! A fork of the original SDFat library by Bill Greiman.
Loading...
Searching...
No Matches
Public Member Functions | List of all members
ifstream Class Reference

file input stream. More...

#include <fstream.h>

Inherits istream, and StreamBaseClass.

Public Member Functions

 ifstream ()
 
 ifstream (const char *path, openmode mode=in)
 
 ~ifstream ()
 
void close ()
 
bool is_open ()
 
void open (const char *path, openmode mode=in)
 
int peek ()
 
- Public Member Functions inherited from istream
 istream ()
 
istream & operator>> (istream &(*pf)(istream &str))
 
istream & operator>> (ios_base &(*pf)(ios_base &str))
 
istream & operator>> (ios &(*pf)(ios &str))
 
istream & operator>> (char *str)
 
istream & operator>> (char &ch)
 
istream & operator>> (signed char *str)
 
istream & operator>> (signed char &ch)
 
istream & operator>> (unsigned char *str)
 
istream & operator>> (unsigned char &ch)
 
istream & operator>> (bool &arg)
 
istream & operator>> (short &arg)
 
istream & operator>> (unsigned short &arg)
 
istream & operator>> (int &arg)
 
istream & operator>> (unsigned int &arg)
 
istream & operator>> (long &arg)
 
istream & operator>> (unsigned long &arg)
 
istream & operator>> (double &arg)
 
istream & operator>> (float &arg)
 
istream & operator>> (void *&arg)
 
streamsize gcount () const
 
int get ()
 
istream & get (char &ch)
 
istream & get (char *str, streamsize n, char delim='\n')
 
istream & getline (char *str, streamsize n, char delim='\n')
 
istream & ignore (streamsize n=1, int delim=-1)
 
int peek ()
 
pos_type tellg ()
 
istream & seekg (pos_type pos)
 
istream & seekg (off_type off, seekdir way)
 
void skipWhite ()
 
- Public Member Functions inherited from ios
 ios ()
 
 operator const void * () const
 
bool operator! () const
 
 operator bool () const
 
iostate rdstate () const
 
bool good () const
 
bool eof () const
 
bool fail () const
 
bool bad () const
 
void clear (iostate state=goodbit)
 
void setstate (iostate state)
 
- Public Member Functions inherited from ios_base
 ios_base ()
 
char fill ()
 
char fill (char c)
 
fmtflags flags () const
 
fmtflags flags (fmtflags fl)
 
int precision () const
 
int precision (unsigned int n)
 
fmtflags setf (fmtflags fl)
 
fmtflags setf (fmtflags fl, fmtflags mask)
 
void unsetf (fmtflags fl)
 
unsigned width ()
 
unsigned width (unsigned n)
 

Additional Inherited Members

- Public Types inherited from ios_base
enum  seekdir { beg , cur , end }
 
typedef unsigned char iostate
 
typedef uint32_t streamsize
 
typedef uint32_t pos_type
 
typedef int32_t off_type
 
typedef uint64_t streamsize
 
typedef uint64_t pos_type
 
typedef int64_t off_type
 
typedef unsigned int fmtflags
 
typedef uint8_t openmode
 
- Static Public Attributes inherited from ios_base
static const iostate goodbit = 0x00
 
static const iostate badbit = 0X01
 
static const iostate eofbit = 0x02
 
static const iostate failbit = 0X04
 
static const fmtflags left = 0x0001
 
static const fmtflags right = 0x0002
 
static const fmtflags internal = 0x0004
 
static const fmtflags dec = 0x0008
 
static const fmtflags hex = 0x0010
 
static const fmtflags oct = 0x0020
 
static const fmtflags boolalpha = 0x0100
 
static const fmtflags showbase = 0x0200
 
static const fmtflags showpoint = 0x0400
 
static const fmtflags showpos = 0x0800
 
static const fmtflags skipws = 0x1000
 
static const fmtflags uppercase = 0x4000
 
static const fmtflags adjustfield = left | right | internal
 
static const fmtflags basefield = dec | hex | oct
 
static const openmode app = 0X4
 
static const openmode ate = 0X8
 
static const openmode binary = 0X10
 
static const openmode in = 0X20
 
static const openmode out = 0X40
 
static const openmode trunc = 0X80
 
- Protected Member Functions inherited from ios_base
uint8_t flagsToBase ()
 
- Private Types inherited from ios_base
enum  seekdir { beg , cur , end }
 
typedef unsigned char iostate
 
typedef uint32_t streamsize
 
typedef uint32_t pos_type
 
typedef int32_t off_type
 
typedef uint64_t streamsize
 
typedef uint64_t pos_type
 
typedef int64_t off_type
 
typedef unsigned int fmtflags
 
typedef uint8_t openmode
 
- Private Member Functions inherited from StreamBaseClass
void clearWriteError ()
 
int16_t getch ()
 
bool getWriteError ()
 
void open (const char *path, ios::openmode mode)
 
ios::openmode getmode ()
 
void putch (char c)
 
void putstr (const char *str)
 
bool seekoff (off_type off, seekdir way)
 
bool seekpos (pos_type pos)
 
void setmode (ios::openmode mode)
 
int write (const void *buf, size_t n)
 
void write (char c)
 
- Private Member Functions inherited from ios
 ios ()
 
 operator const void * () const
 
bool operator! () const
 
 operator bool () const
 
iostate rdstate () const
 
bool good () const
 
bool eof () const
 
bool fail () const
 
bool bad () const
 
void clear (iostate state=goodbit)
 
void setstate (iostate state)
 
- Private Member Functions inherited from ios_base
 ios_base ()
 
char fill ()
 
char fill (char c)
 
fmtflags flags () const
 
fmtflags flags (fmtflags fl)
 
int precision () const
 
int precision (unsigned int n)
 
fmtflags setf (fmtflags fl)
 
fmtflags setf (fmtflags fl, fmtflags mask)
 
void unsetf (fmtflags fl)
 
unsigned width ()
 
unsigned width (unsigned n)
 
uint8_t flagsToBase ()
 
- Static Private Attributes inherited from ios_base
static const iostate goodbit = 0x00
 
static const iostate badbit = 0X01
 
static const iostate eofbit = 0x02
 
static const iostate failbit = 0X04
 
static const fmtflags left = 0x0001
 
static const fmtflags right = 0x0002
 
static const fmtflags internal = 0x0004
 
static const fmtflags dec = 0x0008
 
static const fmtflags hex = 0x0010
 
static const fmtflags oct = 0x0020
 
static const fmtflags boolalpha = 0x0100
 
static const fmtflags showbase = 0x0200
 
static const fmtflags showpoint = 0x0400
 
static const fmtflags showpos = 0x0800
 
static const fmtflags skipws = 0x1000
 
static const fmtflags uppercase = 0x4000
 
static const fmtflags adjustfield = left | right | internal
 
static const fmtflags basefield = dec | hex | oct
 
static const openmode app = 0X4
 
static const openmode ate = 0X8
 
static const openmode binary = 0X10
 
static const openmode in = 0X20
 
static const openmode out = 0X40
 
static const openmode trunc = 0X80
 

Detailed Description

file input stream.

Constructor & Destructor Documentation

◆ ifstream() [1/2]

ifstream::ifstream ( )
inline

◆ ifstream() [2/2]

ifstream::ifstream ( const char *  path,
openmode  mode = in 
)
inlineexplicit

Constructor with open

Parameters
[in]pathfile to open
[in]modeopen mode

◆ ~ifstream()

ifstream::~ifstream ( )
inline

Member Function Documentation

◆ close()

void ifstream::close ( )
inline

Close a file and force cached data and directory information to be written to the storage device.

◆ is_open()

bool ifstream::is_open ( )
inline
Returns
True if stream is open else false.

◆ open()

void ifstream::open ( const char *  path,
openmode  mode = in 
)
inline

Open an ifstream

Parameters
[in]pathfile to open
[in]modeopen mode

mode See fstream::open() for valid modes.

◆ peek()

int istream::peek ( )

Return the next available character without consuming it.

Returns
The character if the stream state is good else -1;
The documentation for this class was generated from the following file: