Provides formatted output to stream. More...

#include <Print.h>

Inheritance diagram for Print:
[legend]

Public Member Functions

virtual ~Print ()
 
int getWriteError ()
 Gets last error. More...
 
void clearWriteError ()
 Clears the last write error. More...
 
virtual size_t write (uint8_t c)=0
 Writes a single character to output stream. More...
 
size_t write (const char *str)
 Writes a c-string to output stream. More...
 
virtual size_t write (const uint8_t *buffer, size_t size)
 Writes characters from a buffer to output stream. More...
 
size_t write (const char *buffer, size_t size)
 Writes characters from a buffer to output stream. More...
 
size_t print (char c)
 Prints a single character to output stream. More...
 
size_t print (const char str[])
 Prints a c-string to output stream. More...
 
size_t print (double num, int digits=2)
 Print a floating-point number to output stream. More...
 
size_t print (const Printable &p)
 Prints a Printable object to output stream. More...
 
size_t print (const String &s)
 Prints a String to output stream. More...
 
size_t println ()
 Prints a newline to output stream. More...
 
size_t println (const char str[])
 Prints a c-string to output stream, appending newline. More...
 
size_t println (char c)
 Prints a single character to output stream, appending newline. More...
 
size_t println (double num, int digits=2)
 Print a floating-point number to output stream, appending newline. More...
 
size_t println (const Printable &p)
 Prints a Printable object to output stream, appending newline. More...
 
size_t println (const String &s)
 Prints a String to output stream, appending newline. More...
 
size_t printf (const char *fmt,...) __attribute__((format(printf
 Prints a formatted c-string to output stream. More...
 
Print an integral number to output stream
Parameters
numNumber to print
baseThe base for output (Default: Decimal (base 10))
Return values
size_tQuantity of characters written to stream
size_t print (unsigned long num, int base=DEC)
 
size_t print (const unsigned long long &num, int base=DEC)
 
size_t print (long, int base=DEC)
 
size_t print (const long long &, int base=DEC)
 
size_t print (unsigned int num, int base=DEC)
 
size_t print (unsigned char num, int base=DEC)
 
size_t print (int num, int base=DEC)
 
Print an integral number to output stream, appending newline
Parameters
numNumber to print
baseThe base for output (Default: Decimal (base 10))
Return values
size_tQuantity of characters written to stream
size_t println (unsigned char num, int base=DEC)
 
size_t println (unsigned int num, int base=DEC)
 
size_t println (unsigned long num, int base=DEC)
 
size_t println (const unsigned long long &num, int base=DEC)
 
size_t println (int num, int base=DEC)
 
size_t println (long num, int base=DEC)
 
size_t println (const long long &num, int base=DEC)
 

Protected Member Functions

void setWriteError (int err=1)
 

Detailed Description

Provides formatted output to stream.

Constructor & Destructor Documentation

◆ ~Print()

virtual Print::~Print ( )
inlinevirtual

Member Function Documentation

◆ clearWriteError()

void Print::clearWriteError ( )
inline

Clears the last write error.

◆ getWriteError()

int Print::getWriteError ( )
inline

Gets last error.

Return values
intError number of last write error

◆ print() [1/12]

size_t Print::print ( char  c)
inline

Prints a single character to output stream.

Parameters
cCharacter to print
Return values
size_tQuantity of characters written to stream

◆ print() [2/12]

size_t Print::print ( const char  str[])
inline

Prints a c-string to output stream.

Parameters
strc-string to print
Return values
size_tQuantity of characters written to output stream

◆ print() [3/12]

size_t Print::print ( unsigned long  num,
int  base = DEC 
)
inline

◆ print() [4/12]

size_t Print::print ( const unsigned long long &  num,
int  base = DEC 
)
inline

◆ print() [5/12]

size_t Print::print ( long  ,
int  base = DEC 
)

◆ print() [6/12]

size_t Print::print ( const long long &  ,
int  base = DEC 
)

◆ print() [7/12]

size_t Print::print ( unsigned int  num,
int  base = DEC 
)
inline

◆ print() [8/12]

size_t Print::print ( unsigned char  num,
int  base = DEC 
)
inline

◆ print() [9/12]

size_t Print::print ( int  num,
int  base = DEC 
)
inline

◆ print() [10/12]

size_t Print::print ( double  num,
int  digits = 2 
)
inline

Print a floating-point number to output stream.

Parameters
numNumber to print
digitsThe decimal places to print (Default: 2, e.g. 21.35)
Return values
size_tQuantity of characters written to stream

◆ print() [11/12]

size_t Print::print ( const Printable p)
inline

Prints a Printable object to output stream.

Parameters
pObject to print
Return values
size_tQuantity of characters written to stream

◆ print() [12/12]

size_t Print::print ( const String s)
inline

Prints a String to output stream.

Parameters
sString to print
Return values
size_tQuantity of characters written to stream

◆ printf()

size_t Print::printf ( const char *  fmt,
  ... 
)

Prints a formatted c-string to output stream.

Parameters
fmtPointer to formated c-string to print
...Parameters for placeholders within formated string
Return values
size_tQuantity of characters written to stream
Note
Use standard printf placeholders, e.g. d for integer, s for c-string, etc.

◆ println() [1/13]

size_t Print::println ( )
inline

Prints a newline to output stream.

Return values
size_tQuantity of characters written to stream

◆ println() [2/13]

size_t Print::println ( const char  str[])
inline

Prints a c-string to output stream, appending newline.

Parameters
strc-string to print
Return values
size_tQuantity of characters written to stream

◆ println() [3/13]

size_t Print::println ( char  c)
inline

Prints a single character to output stream, appending newline.

Parameters
cCharacter to print
Return values
size_tQuantity of characters written to stream

◆ println() [4/13]

size_t Print::println ( unsigned char  num,
int  base = DEC 
)
inline

◆ println() [5/13]

size_t Print::println ( unsigned int  num,
int  base = DEC 
)
inline

◆ println() [6/13]

size_t Print::println ( unsigned long  num,
int  base = DEC 
)
inline

◆ println() [7/13]

size_t Print::println ( const unsigned long long &  num,
int  base = DEC 
)
inline

◆ println() [8/13]

size_t Print::println ( int  num,
int  base = DEC 
)
inline

◆ println() [9/13]

size_t Print::println ( long  num,
int  base = DEC 
)
inline

◆ println() [10/13]

size_t Print::println ( const long long &  num,
int  base = DEC 
)
inline

◆ println() [11/13]

size_t Print::println ( double  num,
int  digits = 2 
)
inline

Print a floating-point number to output stream, appending newline.

Parameters
numNumber to print
digitsThe decimal places to print (Default: 2, e.g. 21.35)
Return values
size_tQuantity of characters written to stream

◆ println() [12/13]

size_t Print::println ( const Printable p)
inline

Prints a Printable object to output stream, appending newline.

Parameters
pObject to print
Return values
size_tQuantity of characters written to stream

◆ println() [13/13]

size_t Print::println ( const String s)
inline

Prints a String to output stream, appending newline.

Parameters
sString to print
Return values
size_tQuantity of characters written to stream

◆ setWriteError()

void Print::setWriteError ( int  err = 1)
inlineprotected

◆ write() [1/4]

virtual size_t Print::write ( uint8_t  c)
pure virtual

Writes a single character to output stream.

Parameters
cCharacter to write to output stream
Return values
size_tQuantity of characters written to output stream

Implemented in IDataSourceStream, DebugClass, CircularBuffer, TwoWire, CommandOutput, and ReadWriteStream.

◆ write() [2/4]

size_t Print::write ( const char *  str)
inline

Writes a c-string to output stream.

Parameters
strPointer to c-string
Return values
size_tQuantity of characters written to stream

◆ write() [3/4]

virtual size_t Print::write ( const uint8_t *  buffer,
size_t  size 
)
virtual

Writes characters from a buffer to output stream.

Parameters
bufferPointer to character buffer
sizeQuantity of characters to write
Return values
size_tQuantity of characters written to stream

Reimplemented in HardwareSerial, CircularBuffer, OtaUpgrade::BasicStream, LimitedMemoryStream, MemoryDataStream, IFS::FileStream, TwoWire, EndlessMemoryStream, Storage::PartitionStream, OtaUpgrade::EncryptedStream, and ReadWriteStream.

◆ write() [4/4]

size_t Print::write ( const char *  buffer,
size_t  size 
)
inline

Writes characters from a buffer to output stream.

Parameters
bufferPointer to character buffer
sizeQuantity of characters to write
Return values
size_tQuantity of characters written to stream

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