Output Stream.
More...
#include <ostream.h>
List of all members.
Detailed Description
Output Stream.
Member Typedef Documentation
typedef for iostate bitmask
type for relative seek offset
typedef for iostream open mode
type for absolute seek position
unsigned size that can represent maximum file size. (violates spec - should be signed)
Member Enumeration Documentation
enumerated type for the direction of relative seeks
- Enumerator:
beg |
seek relative to the beginning of the stream
|
cur |
seek relative to the current stream position
|
end |
seek relative to the end of the stream
|
Member Function Documentation
bool ios::bad |
( |
) |
const [inline, inherited] |
- Returns:
- true if bad bit is set else false.
Clear iostate bits.
- Parameters:
-
[in] | state | The flags you want to set after clearing all flags. |
Reimplemented in fstream, and ofstream.
bool ios::eof |
( |
) |
const [inline, inherited] |
- Returns:
- true if end of file has been reached else false.
Warning: An empty file returns false before the first read.
Moral: eof() is only useful in combination with fail(), to find out whether EOF was the cause for failure
bool ios::fail |
( |
) |
const [inline, inherited] |
- Returns:
- true if any iostate bit other than eof are set else false.
char ios_base::fill |
( |
char |
c ) |
[inline, inherited] |
Set fill character
- Parameters:
-
- Returns:
- old fill character
char ios_base::fill |
( |
) |
[inline, inherited] |
fmtflags ios_base::flags |
( |
) |
const [inline, inherited] |
set format flags
- Parameters:
-
- Returns:
- old flags
uint8_t ios_base::flagsToBase |
( |
) |
[inline, inherited] |
- Returns:
- current number base
ostream& ostream::flush |
( |
) |
[inline] |
Flushes the buffer associated with this stream. The flush function calls the sync function of the associated file.
- Returns:
- A reference to the ostream object.
bool ios::good |
( |
) |
const [inline, inherited] |
- Returns:
- True if no iostate flags are set else false.
ios::operator const void * |
( |
) |
const [inline, inherited] |
- Returns:
- null pointer if fail() is true.
bool ios::operator! |
( |
) |
const [inline, inherited] |
- Returns:
- true if fail() else false.
call manipulator
- Parameters:
-
- Returns:
- the stream
Output a string from flash
- Parameters:
-
[in] | arg | pgm struct pointing to string |
- Returns:
- the stream
ostream& ostream::operator<< |
( |
signed char |
arg ) |
[inline] |
Output character
- Parameters:
-
[in] | arg | character to output |
- Returns:
- the stream
ostream& ostream::operator<< |
( |
bool |
arg ) |
[inline] |
Output bool
- Parameters:
-
- Returns:
- the stream
ostream& ostream::operator<< |
( |
const char * |
arg ) |
[inline] |
Output string
- Parameters:
-
- Returns:
- the stream
ostream& ostream::operator<< |
( |
unsigned char |
arg ) |
[inline] |
Output character
- Parameters:
-
[in] | arg | character to output |
- Returns:
- the stream
ostream& ostream::operator<< |
( |
double |
arg ) |
[inline] |
Output double
- Parameters:
-
- Returns:
- the stream
call manipulator
- Parameters:
-
- Returns:
- the stream
ostream& ostream::operator<< |
( |
int16_t |
arg ) |
[inline] |
Output signed int
- Parameters:
-
- Returns:
- the stream
ostream& ostream::operator<< |
( |
const signed char * |
arg ) |
[inline] |
Output string
- Parameters:
-
- Returns:
- the stream
ostream& ostream::operator<< |
( |
const unsigned char * |
arg ) |
[inline] |
Output string
- Parameters:
-
- Returns:
- the stream
ostream& ostream::operator<< |
( |
uint16_t |
arg ) |
[inline] |
Output unsigned int
- Parameters:
-
- Returns:
- the stream
ostream& ostream::operator<< |
( |
int32_t |
arg ) |
[inline] |
Output signed long
- Parameters:
-
- Returns:
- the stream
ostream& ostream::operator<< |
( |
uint32_t |
arg ) |
[inline] |
Output uint32_t
- Parameters:
-
- Returns:
- the stream
ostream& ostream::operator<< |
( |
char |
arg ) |
[inline] |
Output character
- Parameters:
-
[in] | arg | character to output |
- Returns:
- the stream
ostream& ostream::operator<< |
( |
const void * |
arg ) |
[inline] |
Output pointer
- Parameters:
-
- Returns:
- the stream
int ios_base::precision |
( |
) |
const [inline, inherited] |
int ios_base::precision |
( |
unsigned int |
n ) |
[inline, inherited] |
set precision
- Parameters:
-
- Returns:
- old precision
ostream& ostream::put |
( |
char |
ch ) |
[inline] |
Puts a character in a stream.
The unformatted output function inserts the element ch. It returns *this.
- Parameters:
-
- Returns:
- A reference to the ostream object.
iostate ios::rdstate |
( |
) |
const [inline, inherited] |
- Returns:
- The iostate flags for this SdFile.
Set the stream position
- Parameters:
-
[in] | off | An offset to move the read pointer relative to way. off is a signed 32-bit int so the offset is limited to +- 2GB. |
[in] | way | One of the ios_base::seekdir enumerations. |
- Returns:
- Is always *this. Failure is indicated by the state of *this.
Set the stream position
- Parameters:
-
[in] | pos | The absolute position in which to move the read pointer. |
- Returns:
- Is always *this. Failure is indicated by the state of *this.
set format flags
- Parameters:
-
[in] | fl | new flags to be or'ed in |
- Returns:
- old flags
modify format flags
- Parameters:
-
[in] | mask | flags to be removed |
[in] | fl | flags to be set after mask bits have been cleared |
- Returns:
- old flags
void ios::setstate |
( |
iostate |
state ) |
[inline, inherited] |
Set iostate bits.
- Parameters:
-
- Returns:
- the stream position
void ios_base::unsetf |
( |
fmtflags |
fl ) |
[inline, inherited] |
clear format flags
- Parameters:
-
[in] | fl | flags to be cleared |
- Returns:
- old flags
int ios_base::width |
( |
unsigned int |
n ) |
[inline, inherited] |
set width
- Parameters:
-
- Returns:
- old width
int ios_base::width |
( |
) |
[inline, inherited] |
Member Data Documentation
seek to end before each write
open and seek to end immediately after opening
iostate bad bit for a non-recoverable error.
perform input and output in binary mode (as opposed to text mode)
use strings true/false for bool
iostate bit for end of file reached
iostate fail bit for non-fatal error
fill between sign/base prefix and number
use prefix 0X for hex and 0 for oct
always show '.' for floating numbes
show + sign for non-negative numbers
truncate an existing stream when opening
use uppercase letters in number representations
The documentation for this class was generated from the following files:
- Arduino/libraries/SdFat/ostream.h
- Arduino/libraries/SdFat/ostream.cpp