Qore Qdx Module Reference
1.1.1
|
a line-based input stream iterator for post-processing HTML and JS files created for Qore documentation More...
Public Member Methods | |
constructor (Qore::InputStream is, *string encoding, *string eol, bool do_trim=False) | |
constructor (Qore::StreamReader sr, *string eol, bool do_trim=False) | |
string | getLine () |
Returns the processed version of the current line in the input data or throws an ITERATOR-ERROR exception if the iterator is invalid. More... | |
string | getValue () |
Returns the processed version of the current line in the input data or throws an ITERATOR-ERROR exception if the iterator is invalid. More... | |
Public Member Methods inherited from Qdx::QorePostProcessingInputStreamLineIterator | |
constructor (Qore::InputStream is, *string encoding, *string eol, bool do_trim=False) | |
constructor (Qore::StreamReader sr, *string eol, bool do_trim=False) | |
a line-based input stream iterator for post-processing HTML and JS files created for Qore documentation
Qdx::QorePostProcessingTexInputStreamLineIterator::constructor | ( | Qore::InputStream | is, |
*string | encoding, | ||
*string | eol, | ||
bool | do_trim = False |
||
) |
Creates the object for iterating over the given InputStream
is | the InputStream to iterate over |
encoding | character encoding of the data from input stream; if not ASCII-compatible, all data will be converted to UTF-8; if not present, the default character encoding is assumed |
eol | the optional end of line character(s) to use to detect lines in the data; if this string is not passed, then the end of line character(s) are detected automatically, and can be either "\n" , "\r" , or "\r\n" |
do_trim | if True the string return values for the lines iterated will be trimmed of the eol bytes |
ENCODING-CONVERSION-ERROR | this exception could be thrown if the eol argument has a different character encoding from the data's and an error occurs during encoding conversion |
Qdx::QorePostProcessingTexInputStreamLineIterator::constructor | ( | Qore::StreamReader | sr, |
*string | eol, | ||
bool | do_trim = False |
||
) |
Creates the object for iterating over the given StreamReader
sr | the StreamReader to iterate over |
eol | the optional end of line character(s) to use to detect lines in the data; if this string is not passed, then the end of line character(s) are detected automatically, and can be either "\n" , "\r" , or "\r\n" |
do_trim | if True the string return values for the lines iterated will be trimmed of the eol bytes |
ENCODING-CONVERSION-ERROR | this exception could be thrown if the eol argument has a different character encoding from the data's and an error occurs during encoding conversion |
|
virtual |
Returns the processed version of the current line in the input data or throws an ITERATOR-ERROR
exception if the iterator is invalid.
ITERATOR-ERROR
exception if the iterator is invalidITERATOR-ERROR | the iterator is not pointing at a valid element |
ITERATOR-THREAD-ERROR | this exception is thrown if this method is called from any thread other than the thread that created the object |
Reimplemented from Qdx::QorePostProcessingInputStreamLineIterator.
|
virtual |
Returns the processed version of the current line in the input data or throws an ITERATOR-ERROR
exception if the iterator is invalid.
ITERATOR-ERROR
exception if the iterator is invalidITERATOR-ERROR | the iterator is not pointing at a valid element |
ITERATOR-THREAD-ERROR | this exception is thrown if this method is called from any thread other than the thread that created the object |
Reimplemented from Qdx::QorePostProcessingInputStreamLineIterator.