IFS::HtmlDirectoryTemplate Class Reference
Read-only stream access to directory listing with HTML output. More...
#include <HtmlDirectoryTemplate.h>
Inheritance diagram for IFS::HtmlDirectoryTemplate:
Collaboration diagram for IFS::HtmlDirectoryTemplate:
Public Member Functions | |
HtmlDirectoryTemplate (IDataSourceStream *source, Directory *dir) | |
![]() | |
DirectoryTemplate (IDataSourceStream *source, Directory *dir) | |
Directory & | dir () |
bool | nextRecord () override |
Move to next record. More... | |
![]() | |
SectionTemplate (IDataSourceStream *source, uint8_t maxSections=5) | |
void | onGetValue (GetValue callback) |
Set a callback to be invoked. More... | |
void | setFormatter (Formatter &formatter) |
Associate a text format with this template stream. More... | |
Formatter & | formatter () const |
Get the stream format. More... | |
MimeType | getMimeType () const override |
Get the MIME type associated with this template stream. More... | |
const SectionStream & | stream () const |
Access the underlying section stream. More... | |
int | sectionIndex () const |
Get the index for the current section. More... | |
uint8_t | sectionCount () const |
Get number of sections in source stream. More... | |
int | recordIndex () const |
Get current record index. More... | |
bool | gotoSection (uint8_t index) |
Discard current output and change current section. More... | |
void | onNextRecord (NextRecord callback) |
Set a callback to be invoked when a new record is required. More... | |
String | evaluate (char *&expr) override |
Evaluate a template expression. More... | |
String | getValue (const char *name) override |
Fetch a templated value. More... | |
![]() | |
TemplateStream (IDataSourceStream *stream, bool owned=true) | |
Create a template stream. More... | |
~TemplateStream () | |
StreamType | getStreamType () const override |
Get the stream type. 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... | |
void | setVar (const String &name, const String &value) |
Set value of a variable in the template file. More... | |
void | setVars (const Variables &vars) |
Set multiple variables in the template file. More... | |
Variables & | variables () |
Get the template variables. More... | |
String | getName () const override |
Returns name of the resource. More... | |
void | onGetValue (GetValueDelegate callback) |
Set a callback to obtain variable values. More... | |
void | enableOutput (bool enable) |
During processing applications may suppress output of certain sections by calling this method from within the getValue callback. More... | |
bool | isOutputEnabled () const |
Determine if stream output is active. More... | |
void | setDoubleBraces (bool enable) |
Use two braces {{X}} to mark tags. More... | |
String | eval (String expr) |
Evaluate an expression in-situ. 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... | |
virtual int | available () |
Return the total length of the stream. 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... | |
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) |
![]() | |
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) |
![]() | |
virtual | ~Print () |
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 | |
String | getValue (const char *name) override |
Fetch a templated value. More... | |
![]() | |
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... | |
![]() | |
void | setWriteError (int err=1) |
Additional Inherited Members | |
![]() | |
enum | Field { Field::unknown = 0, Field::XX } |
![]() | |
enum | Command { Command::Qunknown = 0, Command::XX } |
enum | Field { Field::unknown = 0, Field::XX } |
using | GetValue = Delegate< String(const char *name)> |
Application callback to process additional fields. More... | |
using | NextRecord = SectionStream::NextRecord |
![]() | |
using | Variables = HashMap< String, String > |
Maps variable names to values. More... | |
using | GetValueDelegate = Delegate< String(const char *name)> |
Callback type to return calculated or externally stored values. More... | |
![]() | |
uint16_t | receiveTimeout = 1000 |
number of milliseconds to wait for the next char before aborting timed read More... | |
Detailed Description
Read-only stream access to directory listing with HTML output.
Constructor & Destructor Documentation
◆ HtmlDirectoryTemplate()
|
inline |
Member Function Documentation
◆ getValue()
|
overrideprotectedvirtual |
Fetch a templated value.
- Parameters
-
name The variable name
- Return values
-
String value, invalid to emit tag unprocessed
Reimplemented from IFS::DirectoryTemplate.
The documentation for this class was generated from the following file: