Presents each section within a source stream as a separate stream. More...

#include <SectionStream.h>

Inheritance diagram for SectionStream:
Collaboration diagram for SectionStream:

Classes

struct  Section
 

Public Types

using NextSection = Delegate< void()>
 Application notification callback when section changes. More...
 
using NextRecord = Delegate< bool()>
 Application callback to move to next record. More...
 

Public Member Functions

 SectionStream (IDataSourceStream *source, uint8_t maxSections=5)
 Construct a section stream with default options. More...
 
 SectionStream (IDataSourceStream *source, uint8_t maxSections, const String &startTag, const String &endTag)
 Construct a section stream. More...
 
int available () override
 Return the total length of the stream. More...
 
uint16_t readMemoryBlock (char *data, int bufSize) override
 Read a block of memory. More...
 
int seekFrom (int offset, SeekOrigin origin) override
 Change position in stream. More...
 
bool isFinished () override
 Check if all data has been read. More...
 
int sectionIndex () const
 
int recordIndex () const
 
size_t count () const
 Get number of sections in this stream. More...
 
const SectiongetSection () const
 Get description of the current section. More...
 
const SectiongetSection (unsigned index) const
 Get description for any section given its index. More...
 
void onNextSection (NextSection callback)
 Register a callback to be invoked when moving to a new section. More...
 
void onNextRecord (NextRecord callback)
 Register a callback to be invoked when moving to a new record. More...
 
bool gotoSection (uint8_t index)
 Goto a new section immediately. More...
 
bool setNewSection (int8_t index)
 Goto a new section after current tag has been processed. More...
 
- Public Member Functions inherited from IDataSourceStream
virtual StreamType getStreamType () const
 Get the stream type. More...
 
virtual bool isValid () const
 Determine if the stream object contains valid data. More...
 
size_t readBytes (char *buffer, size_t length) override
 Read chars from stream into buffer. 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 bool seek (int len)
 Move read cursor. More...
 
size_t write (uint8_t charToWrite) override
 From Stream class: We don't write using this stream. More...
 
void flush () override
 
virtual String id () const
 Returns unique id of the resource. More...
 
virtual String getName () const
 Returns name of the resource. More...
 
virtual MimeType getMimeType () const
 Get MIME type for stream content. More...
 
String readString (size_t maxLen) override
 Overrides Stream method for more efficient reading. More...
 
virtual bool moveString (String &s)
 Memory-based streams may be able to move content into a String. More...
 
virtual size_t readBytes (char *buffer, size_t length)
 Read chars from stream into buffer. More...
 
size_t readBytes (uint8_t *buffer, size_t length)
 
- Public Member Functions inherited from Stream
 Stream ()
 
void setTimeout (unsigned long timeout)
 Set maximum milliseconds to wait for stream data, default is 1 second. More...
 
bool find (const char *target)
 Read data from the stream until the target string is found. More...
 
bool find (const char *target, size_t length)
 Read data from the stream until the target string of given length is found. More...
 
bool findUntil (const char *target, const char *terminator)
 As find() but search ends if the terminator string is found. More...
 
bool findUntil (const char *target, size_t targetLen, const char *terminate, size_t termLen)
 As findUntil(const char*, const char*) but search ends if the terminate string is found. More...
 
long parseInt ()
 Returns the first valid (long) integer value from the current position. More...
 
float parseFloat ()
 float version of parseInt More...
 
size_t readBytes (uint8_t *buffer, size_t length)
 
size_t readBytesUntil (char terminator, char *buffer, size_t length)
 As readBytes() with terminator character. More...
 
String readStringUntil (char terminator)
 
virtual int indexOf (char c)
 
- Public Member Functions inherited from Print
 Print ()
 
 Print (const Print &)=delete
 
 Print (Print &&)=delete
 
virtual ~Print ()
 
Printoperator= (const Print &)=delete
 
Printoperator= (Print &&)=delete
 
int getWriteError ()
 Gets last error. More...
 
void clearWriteError ()
 Clears the last write error. 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...
 
template<typename T >
std::enable_if< has_printTo< T >::value, size_t >::type print (const T &obj)
 Prints a Printable object to output stream. More...
 
size_t print (const String &s)
 Prints a String to output stream. More...
 
template<typename E >
std::enable_if< std::is_enum< E >::value &&!std::is_convertible< E, int >::value, size_t >::type print (E value)
 enums can be printed as strings provided they have a toString(E) implementation. More...
 
size_t println ()
 Prints a newline to output stream. More...
 
template<typename... Args>
size_t println (const Args &... args)
 Print value plus newline to output stream. More...
 
size_t printf (const char *fmt,...)
 Prints a formatted c-string to output stream. More...
 
size_t print (unsigned long num, uint8_t base=DEC)
 
template<typename... Args>
size_t print (unsigned long num, Args... args)
 
template<typename... Args>
size_t print (const unsigned long long &num, Args... args)
 
size_t print (long num, uint8_t base=DEC)
 
template<typename... Args>
size_t print (long num, Args... args)
 
template<typename... Args>
size_t print (const long long &num, Args... args)
 
template<typename... Args>
size_t print (unsigned int num, Args... args)
 
template<typename... Args>
size_t print (unsigned char num, Args... args)
 
template<typename... Args>
size_t print (int num, Args... args)
 

Protected Member Functions

virtual void nextSection ()
 Invoked when moving to a new section. More...
 
virtual bool nextRecord ()
 Move to first/next record. More...
 
- Protected Member Functions inherited from Stream
int timedRead ()
 
int timedPeek ()
 
int peekNextDigit ()
 returns the next numeric digit in the stream or -1 if timeout More...
 
long parseInt (char skipChar)
 Like regular parseInt() but the given skipChar is ignored. More...
 
float parseFloat (char skipChar)
 Like parseInt(skipChar) for float. More...
 
- Protected Member Functions inherited from Print
void setWriteError (int err=1)
 

Additional Inherited Members

- Protected Attributes inherited from Stream
uint16_t receiveTimeout = 1000
 number of milliseconds to wait for the next char before aborting timed read More...
 

Detailed Description

Presents each section within a source stream as a separate stream.

Sections are (by default) marked {!SECTION} ... {/SECTION} This is typically used with templating but can be used with any stream type provided the tags do not conflict with content.

Member Typedef Documentation

◆ NextRecord

Application callback to move to next record.

Return values
booltrue to emit section, false to skip

◆ NextSection

Application notification callback when section changes.

Constructor & Destructor Documentation

◆ SectionStream() [1/2]

SectionStream::SectionStream ( IDataSourceStream source,
uint8_t  maxSections = 5 
)
inline

Construct a section stream with default options.

◆ SectionStream() [2/2]

SectionStream::SectionStream ( IDataSourceStream source,
uint8_t  maxSections,
const String startTag,
const String endTag 
)
inline

Construct a section stream.

Parameters
sourceContains all section data, must support random seeking
startTagUnique text used to mark start of a section
endTagMarks end of a section

Member Function Documentation

◆ available()

int SectionStream::available ( )
inlineoverridevirtual

Return the total length of the stream.

Return values
int-1 is returned when the size cannot be determined

Reimplemented from IDataSourceStream.

◆ count()

size_t SectionStream::count ( ) const
inline

Get number of sections in this stream.

◆ getSection() [1/2]

const Section* SectionStream::getSection ( ) const
inline

Get description of the current section.

Return values
Section*The section information, or nullptr if there is no current section

◆ getSection() [2/2]

const Section* SectionStream::getSection ( unsigned  index) const
inline

Get description for any section given its index.

Return values
Section*The section information, or nullptr if section was not found

◆ gotoSection()

bool SectionStream::gotoSection ( uint8_t  index)

Goto a new section immediately.

◆ isFinished()

bool SectionStream::isFinished ( )
inlineoverridevirtual

Check if all data has been read.

Return values
boolTrue on success.

Implements IDataSourceStream.

◆ nextRecord()

virtual bool SectionStream::nextRecord ( )
inlineprotectedvirtual

Move to first/next record.

Return values
booltrue to emit section, false to skip

◆ nextSection()

virtual void SectionStream::nextSection ( )
protectedvirtual

Invoked when moving to a new section.

◆ onNextRecord()

void SectionStream::onNextRecord ( NextRecord  callback)
inline

Register a callback to be invoked when moving to a new record.

◆ onNextSection()

void SectionStream::onNextSection ( NextSection  callback)
inline

Register a callback to be invoked when moving to a new section.

◆ readMemoryBlock()

uint16_t SectionStream::readMemoryBlock ( char *  data,
int  bufSize 
)
overridevirtual

Read a block of memory.

Parameters
dataPointer to the data to be read
bufSizeQuantity of chars to read
Return values
uint16_tQuantity of chars read
Todo:
Should IDataSourceStream::readMemoryBlock return same data type as its bufSize param?

Implements IDataSourceStream.

◆ recordIndex()

int SectionStream::recordIndex ( ) const
inline

◆ sectionIndex()

int SectionStream::sectionIndex ( ) const
inline

◆ seekFrom()

int SectionStream::seekFrom ( int  offset,
SeekOrigin  origin 
)
overridevirtual

Change position in stream.

Parameters
offset
origin
Return values
Newposition, < 0 on error
Note
This method is implemented by streams which support random seeking, such as files and memory streams.

Reimplemented from IDataSourceStream.

◆ setNewSection()

bool SectionStream::setNewSection ( int8_t  index)
inline

Goto a new section after current tag has been processed.


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