TemplateStream Class Reference

Inheritance diagram for TemplateStream:

Public Member Functions
	TemplateStream (IDataSourceStream *stream)
	Create a template stream. More...
StreamType	getStreamType () const override
	Get the stream type. More...
uint16_t	readMemoryBlock (char *data, int bufSize) override
	Read a block of memory. More...
bool	seek (int len) override
	Move read cursor. More...
bool	isFinished () override
	Check if all data has been read. More...
void	setVar (const String &name, const String &value)
	Set value of a variable in the template file. More...
void	setVars (const TemplateVariables &vars)
	Set multiple variables in the template file. More...
TemplateVariables &	variables ()
	Get the template variables. More...
String	getName () const override
	Returns name of the resource. More...
virtual bool	isValid () const
	Determine if the stream object contains valid data. More...
int	read () override
	Read one character and moves the stream pointer. More...
int	peek () override
	Read a character without advancing the stream pointer. More...
virtual int	available ()
	Return the total length of the stream. More...
size_t	write (uint8_t charToWrite) override
	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...
int	length () SMING_DEPRECATED
	Return the total length of the stream. More...
void	flush () override
virtual String	id () const
	Returns unique id of the resource. More...
void	setTimeout (unsigned long timeout)
bool	find (char *target)
bool	find (char *target, size_t length)
bool	findUntil (char *target, char *terminator)
bool	findUntil (char *target, size_t targetLen, char *terminate, size_t termLen)
long	parseInt ()
float	parseFloat ()
size_t	readBytes (char *buffer, size_t length)
size_t	readBytesUntil (char terminator, char *buffer, size_t length)
String	readString ()
String	readStringUntil (char terminator)
virtual int	indexOf (char c)
int	getWriteError ()
	Gets last error. More...
void	clearWriteError ()
	Clears the last write error. More...
size_t	print (char)
	Prints a single character to output stream. More...
size_t	print (const char[])
	Prints a c-string to output stream. More...
size_t	print (unsigned long, int base=DEC)
	Prints a number to output stream. More...
size_t	print (long, int base=DEC)
	Prints a number to output stream. More...
size_t	print (unsigned int, int base=DEC)
size_t	print (unsigned char, int base=DEC)
size_t	print (int, int base=DEC)
	Prints a number to output stream. More...
size_t	print (double, int digits=2)
	Prints 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 (void)
	Prints a newline to output stream. More...
size_t	println (const char[])
	Prints a c-string to output stream, appending newline. More...
size_t	println (char)
	Prints a single character to output stream, appending newline. More...
size_t	println (unsigned char, int base=DEC)
	Prints a number to output stream, appending newline. More...
size_t	println (unsigned int, int base=DEC)
size_t	println (unsigned long, int base=DEC)
size_t	println (int, int base=DEC)
	Prints a number to output stream, appending newline. More...
size_t	println (long, int base=DEC)
	Prints a number to output stream, appending newline. More...
size_t	println (double, int digits=2)
	Prints a 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,...)
	Prints a formatted c-string to output stream. More...

Protected Member Functions
int	timedRead ()
int	timedPeek ()
int	peekNextDigit ()
long	parseInt (char skipChar)
float	parseFloat (char skipChar)
void	setWriteError (int err=1)

Protected Attributes
unsigned long	receiveTimeout = 1000
unsigned long	startMillis = 0

Constructor & Destructor Documentation

TemplateStream::TemplateStream ( IDataSourceStream *  stream )

inline

Create a template stream.

Parameters

stream

source of template data

Member Function Documentation

virtual int IDataSourceStream::available ( )

inlinevirtualinherited

Return the total length of the stream.

Return values

int	-1 is returned when the size cannot be determined

Implements Stream.

Reimplemented in HardwareSerial, FileStream, GdbFileStream, CircularBuffer, StreamTransformer, MemoryDataStream, JsonObjectStream, LimitedMemoryStream, UrlencodedOutputStream, FlashMemoryStream, MultiStream, and ArduCAMStream.

void Print::clearWriteError ( )

inlineinherited

Clears the last write error.

String TemplateStream::getName ( ) const

inlineoverridevirtual

Returns name of the resource.

Return values

String

Note

Commonly used to obtain name of file

Reimplemented from IDataSourceStream.

StreamType TemplateStream::getStreamType ( ) const

inlineoverridevirtual

Get the stream type.

Return values

StreamType

The stream type.

Reimplemented from IDataSourceStream.

int Print::getWriteError ( )

inlineinherited

Gets last error.

Return values

int	Error number of last write error

virtual String IDataSourceStream::id ( ) const

inlinevirtualinherited

Returns unique id of the resource.

Return values

String

the unique id of the stream.

Reimplemented in FileStream, GdbFileStream, and CircularBuffer.

bool TemplateStream::isFinished ( )

inlineoverridevirtual

Check if all data has been read.

Return values

bool	True on success.

Implements IDataSourceStream.

virtual bool IDataSourceStream::isValid ( ) const

inlinevirtualinherited

Determine if the stream object contains valid data.

Return values

bool	true if valid, false if invalid

Note

Where inherited classes are initialised by constructor this method indicates whether that was successful or not (e.g. FileStream)

Reimplemented in FileStream, and GdbFileStream.

int IDataSourceStream::length ( )

inlineinherited

Return the total length of the stream.

Return values

int	-1 is returned when the size cannot be determined

Deprecated:

Use available() instead

int IDataSourceStream::peek ( )

overridevirtualinherited

Read a character without advancing the stream pointer.

Return values

int	The character that was read or -1 if none is available

Implements Stream.

Reimplemented in HardwareSerial.

size_t Print::print ( char  )

inherited

Prints a single character to output stream.

Return values

size_t

Quantity of characters written to stream

size_t Print::print ( const char  [] )

inherited

Prints a c-string to output stream.

Parameters

char[]

c-string to print

Return values

size_t	Quantity of characters written to output stream
size_t	Quantity of characters written to stream

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

inherited

Prints a number to output stream.

Parameters

unsigned long	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t

Quantity of characters written to stream

Parameters

unsigned int	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t

Quantity of characters written to stream

Parameters

unsigned char	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t

Quantity of characters written to stream

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

inherited

Prints a number to output stream.

Parameters

long	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t

Quantity of characters written to stream

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

inherited

Prints a number to output stream.

Parameters

int	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t

Quantity of characters written to stream

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

inherited

Prints number to output stream.

Prints a number to output stream.

Parameters

double	Number to print
int	Decimal places to show

Return values

size_t

Quantity of characters written to output stream

Parameters

double	Number to print
digits	The decimal places to print (Default: 2, e.g. 21.35)

Return values

size_t

Quantity of characters written to stream

size_t Print::print ( const Printable &  p )

inherited

Prints a Printable object to output stream.

Parameters

p	Object to print

Return values

size_t

Quantity of characters written to stream

size_t Print::print ( const String &  s )

inherited

Prints a String to output stream.

Parameters

s	String to print

Return values

size_t

Quantity of characters written to stream

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

inherited

Prints a formatted c-string to output stream.

Parameters

fmt	Pointer to formated c-string to print
...	Parameters for placeholders within formated string

Return values

size_t

Quantity of characters written to stream

Note

Use standard printf placeholders, e.g. d for integer, s for c-string, etc.

size_t Print::println ( void  )

inherited

Prints a newline to output stream.

Parameters

Prints

newline to output stream

Return values

size_t	Quantity of characters written to output stream
size_t	Quantity of characters written to stream

size_t Print::println ( const char  [] )

inherited

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

Parameters

char[]

c-string to print

Return values

size_t

Quantity of characters written to stream

size_t Print::println ( char  )

inherited

Prints a single character to output stream, appending newline.

Parameters

char	Character to print

Return values

size_t

Quantity of characters written to stream

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

inherited

Prints a number to output stream, appending newline.

Parameters

unsigned char	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t

Quantity of characters written to stream

Parameters

unsigned int	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t

Quantity of characters written to stream

Parameters

unsigned long	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t

Quantity of characters written to stream

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

inherited

Prints a number to output stream, appending newline.

Parameters

int	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t

Quantity of characters written to stream

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

inherited

Prints a number to output stream, appending newline.

Parameters

long	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t

Quantity of characters written to stream

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

inherited

Prints a number to output stream, appending newline.

Parameters

double	Number to print
digits	The decimal places to print (Default: 2, e.g. 21.35)

Return values

size_t

Quantity of characters written to stream

size_t Print::println ( const Printable &  p )

inherited

Prints a Printable object to output stream, appending newline.

Parameters

p	Object to print

Return values

size_t

Quantity of characters written to stream

size_t Print::println ( const String &  s )

inherited

Prints a String to output stream, appending newline.

Parameters

s	String to print

Return values

size_t

Quantity of characters written to stream

int IDataSourceStream::read ( )

overridevirtualinherited

Read one character and moves the stream pointer.

Return values

The	character that was read or -1 if none is available

Implements Stream.

Reimplemented in HardwareSerial.

uint16_t TemplateStream::readMemoryBlock ( char *  data, int  bufSize  )

overridevirtual

Read a block of memory.

Parameters

data	Pointer to the data to be read
bufSize	Quantity of chars to read

Return values

uint16_t

Quantity of chars read

Todo:

Should IDataSourceStream::readMemoryBlock return same data type as its bufSize param?

Implements IDataSourceStream.

bool TemplateStream::seek ( int  len )

overridevirtual

Move read cursor.

Parameters

len	Relative cursor adjustment

Return values

bool	True on success.

Implements IDataSourceStream.

void TemplateStream::setVar ( const String &  name, const String &  value  )

inline

Set value of a variable in the template file.

Parameters

name	Name of variable
value	Value to assign to the variable

Note

Sets and existing variable or adds a new variable if variable does not already exist

void TemplateStream::setVars ( const TemplateVariables &  vars )

inline

Set multiple variables in the template file.

Parameters

vars	Template Variables

TemplateVariables& TemplateStream::variables ( )

inline

Get the template variables.

Return values

TemplateVariables

Reference to the template variables

size_t Print::write ( const char *  str )

inlineinherited

Writes a c-string to output stream.

Parameters

str	Pointer to c-string

Return values

size_t

Quantity of characters written to stream

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

virtualinherited

Writes characters from a buffer to output stream.

Parameters

buffer	Pointer to character buffer
size	Quantity of characters to write

Return values

size_t

Quantity of characters written to stream

Reimplemented in HardwareSerial, CircularBuffer, FileStream, MemoryDataStream, LimitedMemoryStream, TwoWire, EndlessMemoryStream, GdbFileStream, rBootItemOutputStream, and ReadWriteStream.

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

inlineinherited

Writes characters from a buffer to output stream.

Parameters

buffer	Pointer to character buffer
size	Quantity of characters to write

Return values

size_t

Quantity of characters written to stream

size_t IDataSourceStream::write ( uint8_t  )

inlineoverridevirtualinherited

Writes a single character to output stream.

Parameters

uint8_t

Character to write to output stream

Return values

size_t

Quantity of characters written to output stream

Implements Print.

Reimplemented in ReadWriteStream.