\hypertarget{class_qore_1_1_input_stream_line_iterator}{}\section{Qore\+:\+:Input\+Stream\+Line\+Iterator Class Reference}
\label{class_qore_1_1_input_stream_line_iterator}\index{Qore\+::\+Input\+Stream\+Line\+Iterator@{Qore\+::\+Input\+Stream\+Line\+Iterator}}


This class defines a line iterator for input streams.  




Inheritance diagram for Qore\+:\+:Input\+Stream\+Line\+Iterator\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=229pt]{class_qore_1_1_input_stream_line_iterator__inherit__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{class_qore_1_1_input_stream_line_iterator_a731660843719ceaaa5a2aee2c97a58a5}{constructor}} (\mbox{\hyperlink{class_qore_1_1_input_stream}{Qore\+::\+Input\+Stream}} is, \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} encoding, \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} eol, bool \mbox{\hyperlink{group__string__functions_gae8d314e819a299d46d181696600d4293}{trim}}=\mbox{\hyperlink{group__boolean__constants_ga3ba2df91713a6249449347131ea526c3}{True}}, \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} bufsize=\mbox{\hyperlink{group___buffered_stream_reader_ga5a70489b1e5c32585eb23e2a4423c8f9}{Default\+Stream\+Buffer\+Size}})
\begin{DoxyCompactList}\small\item\em Creates the \mbox{\hyperlink{class_qore_1_1_input_stream_line_iterator}{Input\+Stream\+Line\+Iterator}} for iterating over the given {\ttfamily \mbox{\hyperlink{class_qore_1_1_input_stream}{Input\+Stream}}}. \end{DoxyCompactList}\item 
\mbox{\hyperlink{class_qore_1_1_input_stream_line_iterator_a0be69bb1eacbf7614fe211f58a95bdd9}{constructor}} (\mbox{\hyperlink{class_qore_1_1_stream_reader}{Qore\+::\+Stream\+Reader}} sr, \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} eol, bool \mbox{\hyperlink{group__string__functions_gae8d314e819a299d46d181696600d4293}{trim}}=\mbox{\hyperlink{group__boolean__constants_ga3ba2df91713a6249449347131ea526c3}{True}})
\begin{DoxyCompactList}\small\item\em Creates the \mbox{\hyperlink{class_qore_1_1_input_stream_line_iterator}{Input\+Stream\+Line\+Iterator}} for iterating data from the given {\ttfamily \mbox{\hyperlink{class_qore_1_1_stream_reader}{Stream\+Reader}}}. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{class_qore_1_1_input_stream_line_iterator_a305448b7ff5c235f98cf932158e575af}{get\+Encoding}} ()
\begin{DoxyCompactList}\small\item\em Returns the \mbox{\hyperlink{character_encoding}{character encoding}} for the \mbox{\hyperlink{class_qore_1_1_input_stream_line_iterator}{Input\+Stream\+Line\+Iterator}}. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{class_qore_1_1_input_stream_line_iterator_a97843613b1efffb8191a982b034ad35e}{get\+Line}} ()
\begin{DoxyCompactList}\small\item\em Returns the current line in the data or throws an {\ttfamily I\+T\+E\+R\+A\+T\+O\+R-\/\+E\+R\+R\+OR} exception if the iterator is invalid. \end{DoxyCompactList}\item 
\mbox{\hyperlink{class_qore_1_1_stream_reader}{Stream\+Reader}} \mbox{\hyperlink{class_qore_1_1_input_stream_line_iterator_ae6d45c5c3375e246ebf6e8657d16ae07}{get\+Stream\+Reader}} ()
\begin{DoxyCompactList}\small\item\em Returns the \mbox{\hyperlink{class_qore_1_1_stream_reader}{Stream\+Reader}} object used internally. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{class_qore_1_1_input_stream_line_iterator_ac20e677f7b65af6efcad994e8baffcf0}{get\+Value}} ()
\begin{DoxyCompactList}\small\item\em Returns the current line in the data or throws an {\ttfamily I\+T\+E\+R\+A\+T\+O\+R-\/\+E\+R\+R\+OR} exception if the iterator is invalid. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} \mbox{\hyperlink{class_qore_1_1_input_stream_line_iterator_ac2a16a29cd14271505149e96c144c814}{index}} ()
\begin{DoxyCompactList}\small\item\em Returns the current iterator line number in the data (the first line is line 1) or 0 if not pointing at a valid element. \end{DoxyCompactList}\item 
bool \mbox{\hyperlink{class_qore_1_1_input_stream_line_iterator_a15869ee0a81ae224334f83f681b6e760}{next}} ()
\begin{DoxyCompactList}\small\item\em Moves the current position to the next line in the data; returns \mbox{\hyperlink{group__boolean__constants_ga9da2b9a8003cd3788e48305f8a00540f}{False}} if there are no more lines to read; if the iterator is not pointing at a valid element before this call, the iterator will be positioned to the beginning of the data. \end{DoxyCompactList}\item 
bool \mbox{\hyperlink{class_qore_1_1_input_stream_line_iterator_ad67679ac159cec3362a5faed21f0dcdb}{valid}} ()
\begin{DoxyCompactList}\small\item\em Returns \mbox{\hyperlink{group__boolean__constants_ga3ba2df91713a6249449347131ea526c3}{True}} if the iterator is currently pointing at a valid element, \mbox{\hyperlink{group__boolean__constants_ga9da2b9a8003cd3788e48305f8a00540f}{False}} if not. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
This class defines a line iterator for input streams. 

\begin{DoxySince}{Since}
Qore 0.\+8.\+13
\end{DoxySince}
\begin{DoxyParagraph}{Example\+: Input\+Stream\+Line\+Iterator basic usage}

\begin{DoxyCode}
FileInputStream fis(\textcolor{stringliteral}{"log.txt"});
InputStreamLineIterator it(fis, \textcolor{stringliteral}{"\(\backslash\)n"});
\textcolor{keywordflow}{while} (it.next()) \{
    \mbox{\hyperlink{group__string__functions_ga32070517a9f8a70a32ef48f83a6f128e}{printf}}(\textcolor{stringliteral}{"line %d = %n\(\backslash\)n"}, it.index(), it.getLine());
\}
\end{DoxyCode}

\end{DoxyParagraph}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{class_qore_1_1_data_line_iterator}{Qore\+::\+Data\+Line\+Iterator}} 

\mbox{\hyperlink{class_qore_1_1_file_line_iterator}{Qore\+::\+File\+Line\+Iterator}} 
\end{DoxySeeAlso}


\subsection{Member Function Documentation}
\mbox{\Hypertarget{class_qore_1_1_input_stream_line_iterator_a731660843719ceaaa5a2aee2c97a58a5}\label{class_qore_1_1_input_stream_line_iterator_a731660843719ceaaa5a2aee2c97a58a5}} 
\index{Qore\+::\+Input\+Stream\+Line\+Iterator@{Qore\+::\+Input\+Stream\+Line\+Iterator}!constructor@{constructor}}
\index{constructor@{constructor}!Qore\+::\+Input\+Stream\+Line\+Iterator@{Qore\+::\+Input\+Stream\+Line\+Iterator}}
\subsubsection{\texorpdfstring{constructor()}{constructor()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily Qore\+::\+Input\+Stream\+Line\+Iterator\+::constructor (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_qore_1_1_input_stream}{Qore\+::\+Input\+Stream}}}]{is,  }\item[{\+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{encoding,  }\item[{\+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{eol,  }\item[{bool}]{trim = {\ttfamily \mbox{\hyperlink{group__boolean__constants_ga3ba2df91713a6249449347131ea526c3}{True}}},  }\item[{\mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}}}]{bufsize = {\ttfamily \mbox{\hyperlink{group___buffered_stream_reader_ga5a70489b1e5c32585eb23e2a4423c8f9}{Default\+Stream\+Buffer\+Size}}} }\end{DoxyParamCaption})}



Creates the \mbox{\hyperlink{class_qore_1_1_input_stream_line_iterator}{Input\+Stream\+Line\+Iterator}} for iterating over the given {\ttfamily \mbox{\hyperlink{class_qore_1_1_input_stream}{Input\+Stream}}}. 


\begin{DoxyParams}{Parameters}
{\em is} & the {\ttfamily \mbox{\hyperlink{class_qore_1_1_input_stream}{Input\+Stream}}} to iterate over \\
\hline
{\em encoding} & character encoding of the data from input stream; if not A\+S\+C\+I\+I-\/compatible, all data will be converted to U\+T\+F-\/8; if not present, the \mbox{\hyperlink{character_encoding_default_encoding}{default character encoding}} is assumed \\
\hline
{\em eol} & the optional end of line character(s) to use to detect lines in the data; if this string is not passed, then if the character-\/encoding is A\+S\+C\+I\+I-\/compatible, the end of line character(s) are detected automatically from {\ttfamily \char`\"{}\textbackslash{}n\char`\"{}}, {\ttfamily \char`\"{}\textbackslash{}r\char`\"{}}, or {\ttfamily \char`\"{}\textbackslash{}r\textbackslash{}n\char`\"{}}; if the stream uses a non-\/\+A\+S\+C\+I\+I-\/compatible character encoding, then {\ttfamily \char`\"{}\textbackslash{}n\char`\"{}} is assumed \\
\hline
{\em trim} & if \mbox{\hyperlink{group__boolean__constants_ga3ba2df91713a6249449347131ea526c3}{True}} the string return values for the lines iterated will be trimmed of the eol bytes \\
\hline
{\em bufsize} & the size of the buffer for the internal \mbox{\hyperlink{group___buffered_stream_reader}{Constants}} in bytes; must be a positive integer\\
\hline
\end{DoxyParams}

\begin{DoxyExceptions}{Exceptions}
{\em S\+T\+R\+E\+A\+M-\/\+B\+U\+F\+F\+E\+R-\/\+E\+R\+R\+OR} & an invalid stream buffer size was specified; the buffer size must be a positive integer \\
\hline
{\em E\+N\+C\+O\+D\+I\+N\+G-\/\+C\+O\+N\+V\+E\+R\+S\+I\+O\+N-\/\+E\+R\+R\+OR} & this exception could be thrown if the eol argument has a different \mbox{\hyperlink{character_encoding}{character encoding}} from the data\textquotesingle{}s and an error occurs during encoding conversion\\
\hline
\end{DoxyExceptions}
\begin{DoxyNote}{Note}
this variant of the \mbox{\hyperlink{class_qore_1_1_input_stream_line_iterator_a731660843719ceaaa5a2aee2c97a58a5}{Input\+Stream\+Line\+Iterator\+::constructor}} creates a \mbox{\hyperlink{group___buffered_stream_reader}{Constants}} to read the input data 
\end{DoxyNote}
\mbox{\Hypertarget{class_qore_1_1_input_stream_line_iterator_a0be69bb1eacbf7614fe211f58a95bdd9}\label{class_qore_1_1_input_stream_line_iterator_a0be69bb1eacbf7614fe211f58a95bdd9}} 
\index{Qore\+::\+Input\+Stream\+Line\+Iterator@{Qore\+::\+Input\+Stream\+Line\+Iterator}!constructor@{constructor}}
\index{constructor@{constructor}!Qore\+::\+Input\+Stream\+Line\+Iterator@{Qore\+::\+Input\+Stream\+Line\+Iterator}}
\subsubsection{\texorpdfstring{constructor()}{constructor()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily Qore\+::\+Input\+Stream\+Line\+Iterator\+::constructor (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_qore_1_1_stream_reader}{Qore\+::\+Stream\+Reader}}}]{sr,  }\item[{\+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{eol,  }\item[{bool}]{trim = {\ttfamily \mbox{\hyperlink{group__boolean__constants_ga3ba2df91713a6249449347131ea526c3}{True}}} }\end{DoxyParamCaption})}



Creates the \mbox{\hyperlink{class_qore_1_1_input_stream_line_iterator}{Input\+Stream\+Line\+Iterator}} for iterating data from the given {\ttfamily \mbox{\hyperlink{class_qore_1_1_stream_reader}{Stream\+Reader}}}. 


\begin{DoxyParams}{Parameters}
{\em sr} & the {\ttfamily \mbox{\hyperlink{class_qore_1_1_stream_reader}{Stream\+Reader}}} used as a source of data to iterate over \\
\hline
{\em eol} & the optional end of line character(s) to use to detect lines in the data; if this string is not passed, then if the character-\/encoding is A\+S\+C\+I\+I-\/compatible, the end of line character(s) are detected automatically from {\ttfamily \char`\"{}\textbackslash{}n\char`\"{}}, {\ttfamily \char`\"{}\textbackslash{}r\char`\"{}}, or {\ttfamily \char`\"{}\textbackslash{}r\textbackslash{}n\char`\"{}}; if the stream uses a non-\/\+A\+S\+C\+I\+I-\/compatible character encoding, then {\ttfamily \char`\"{}\textbackslash{}n\char`\"{}} is assumed \\
\hline
{\em trim} & if \mbox{\hyperlink{group__boolean__constants_ga3ba2df91713a6249449347131ea526c3}{True}} the string return values for the lines iterated will be trimmed of the eol bytes\\
\hline
\end{DoxyParams}

\begin{DoxyExceptions}{Exceptions}
{\em E\+N\+C\+O\+D\+I\+N\+G-\/\+C\+O\+N\+V\+E\+R\+S\+I\+O\+N-\/\+E\+R\+R\+OR} & this exception could be thrown if the eol argument has a different \mbox{\hyperlink{character_encoding}{character encoding}} from the data\textquotesingle{}s and an error occurs during encoding conversion \\
\hline
\end{DoxyExceptions}
\mbox{\Hypertarget{class_qore_1_1_input_stream_line_iterator_a305448b7ff5c235f98cf932158e575af}\label{class_qore_1_1_input_stream_line_iterator_a305448b7ff5c235f98cf932158e575af}} 
\index{Qore\+::\+Input\+Stream\+Line\+Iterator@{Qore\+::\+Input\+Stream\+Line\+Iterator}!get\+Encoding@{get\+Encoding}}
\index{get\+Encoding@{get\+Encoding}!Qore\+::\+Input\+Stream\+Line\+Iterator@{Qore\+::\+Input\+Stream\+Line\+Iterator}}
\subsubsection{\texorpdfstring{get\+Encoding()}{getEncoding()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::\+Input\+Stream\+Line\+Iterator\+::get\+Encoding (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Returns the \mbox{\hyperlink{character_encoding}{character encoding}} for the \mbox{\hyperlink{class_qore_1_1_input_stream_line_iterator}{Input\+Stream\+Line\+Iterator}}. 

\begin{DoxyParagraph}{Code Flags\+:}
\mbox{\hyperlink{code_flags_CONSTANT}{C\+O\+N\+S\+T\+A\+NT}}
\end{DoxyParagraph}
\begin{DoxyParagraph}{Example\+:}

\begin{DoxyCode}
string encoding = i.getEncoding();
\end{DoxyCode}

\end{DoxyParagraph}
\begin{DoxyReturn}{Returns}
the \mbox{\hyperlink{character_encoding}{character encoding}} for the \mbox{\hyperlink{class_qore_1_1_input_stream_line_iterator}{Input\+Stream\+Line\+Iterator}} 
\end{DoxyReturn}
\mbox{\Hypertarget{class_qore_1_1_input_stream_line_iterator_a97843613b1efffb8191a982b034ad35e}\label{class_qore_1_1_input_stream_line_iterator_a97843613b1efffb8191a982b034ad35e}} 
\index{Qore\+::\+Input\+Stream\+Line\+Iterator@{Qore\+::\+Input\+Stream\+Line\+Iterator}!get\+Line@{get\+Line}}
\index{get\+Line@{get\+Line}!Qore\+::\+Input\+Stream\+Line\+Iterator@{Qore\+::\+Input\+Stream\+Line\+Iterator}}
\subsubsection{\texorpdfstring{get\+Line()}{getLine()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::\+Input\+Stream\+Line\+Iterator\+::get\+Line (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Returns the current line in the data or throws an {\ttfamily I\+T\+E\+R\+A\+T\+O\+R-\/\+E\+R\+R\+OR} exception if the iterator is invalid. 

\begin{DoxyReturn}{Returns}
the current line in the data or throws an {\ttfamily I\+T\+E\+R\+A\+T\+O\+R-\/\+E\+R\+R\+OR} exception if the iterator is invalid
\end{DoxyReturn}
\begin{DoxyParagraph}{Code Flags\+:}
\mbox{\hyperlink{code_flags_RET_VALUE_ONLY}{R\+E\+T\+\_\+\+V\+A\+L\+U\+E\+\_\+\+O\+N\+LY}}
\end{DoxyParagraph}
\begin{DoxyParagraph}{Example\+:}

\begin{DoxyCode}
\textcolor{keywordflow}{while} (i.next()) \{
    \mbox{\hyperlink{group__string__functions_ga32070517a9f8a70a32ef48f83a6f128e}{printf}}(\textcolor{stringliteral}{"+ %y\(\backslash\)n"}, i.getLine());
\}
\end{DoxyCode}

\end{DoxyParagraph}

\begin{DoxyExceptions}{Exceptions}
{\em I\+T\+E\+R\+A\+T\+O\+R-\/\+E\+R\+R\+OR} & the iterator is not pointing at a valid element \\
\hline
{\em I\+T\+E\+R\+A\+T\+O\+R-\/\+T\+H\+R\+E\+A\+D-\/\+E\+R\+R\+OR} & this exception is thrown if this method is called from any thread other than the thread that created the object\\
\hline
\end{DoxyExceptions}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{class_qore_1_1_input_stream_line_iterator_ac20e677f7b65af6efcad994e8baffcf0}{Input\+Stream\+Line\+Iterator\+::get\+Value()}} 
\end{DoxySeeAlso}


Implements \mbox{\hyperlink{class_qore_1_1_abstract_line_iterator_a8ad4c0503f09b24e93bbeac266f2b2a0}{Qore\+::\+Abstract\+Line\+Iterator}}.

\mbox{\Hypertarget{class_qore_1_1_input_stream_line_iterator_ae6d45c5c3375e246ebf6e8657d16ae07}\label{class_qore_1_1_input_stream_line_iterator_ae6d45c5c3375e246ebf6e8657d16ae07}} 
\index{Qore\+::\+Input\+Stream\+Line\+Iterator@{Qore\+::\+Input\+Stream\+Line\+Iterator}!get\+Stream\+Reader@{get\+Stream\+Reader}}
\index{get\+Stream\+Reader@{get\+Stream\+Reader}!Qore\+::\+Input\+Stream\+Line\+Iterator@{Qore\+::\+Input\+Stream\+Line\+Iterator}}
\subsubsection{\texorpdfstring{get\+Stream\+Reader()}{getStreamReader()}}
{\footnotesize\ttfamily \mbox{\hyperlink{class_qore_1_1_stream_reader}{Stream\+Reader}} Qore\+::\+Input\+Stream\+Line\+Iterator\+::get\+Stream\+Reader (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Returns the \mbox{\hyperlink{class_qore_1_1_stream_reader}{Stream\+Reader}} object used internally. 

\begin{DoxyParagraph}{Example\+:}

\begin{DoxyCode}
StreamReader sr = i.getStreamReader();
\end{DoxyCode}

\end{DoxyParagraph}
\begin{DoxyReturn}{Returns}
the \mbox{\hyperlink{class_qore_1_1_stream_reader}{Stream\+Reader}} object used internally 
\end{DoxyReturn}
\mbox{\Hypertarget{class_qore_1_1_input_stream_line_iterator_ac20e677f7b65af6efcad994e8baffcf0}\label{class_qore_1_1_input_stream_line_iterator_ac20e677f7b65af6efcad994e8baffcf0}} 
\index{Qore\+::\+Input\+Stream\+Line\+Iterator@{Qore\+::\+Input\+Stream\+Line\+Iterator}!get\+Value@{get\+Value}}
\index{get\+Value@{get\+Value}!Qore\+::\+Input\+Stream\+Line\+Iterator@{Qore\+::\+Input\+Stream\+Line\+Iterator}}
\subsubsection{\texorpdfstring{get\+Value()}{getValue()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::\+Input\+Stream\+Line\+Iterator\+::get\+Value (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Returns the current line in the data or throws an {\ttfamily I\+T\+E\+R\+A\+T\+O\+R-\/\+E\+R\+R\+OR} exception if the iterator is invalid. 

\begin{DoxyReturn}{Returns}
the current line in the data or throws an {\ttfamily I\+T\+E\+R\+A\+T\+O\+R-\/\+E\+R\+R\+OR} exception if the iterator is invalid
\end{DoxyReturn}
\begin{DoxyParagraph}{Code Flags\+:}
\mbox{\hyperlink{code_flags_RET_VALUE_ONLY}{R\+E\+T\+\_\+\+V\+A\+L\+U\+E\+\_\+\+O\+N\+LY}}
\end{DoxyParagraph}
\begin{DoxyParagraph}{Example\+:}

\begin{DoxyCode}
\textcolor{keywordflow}{while} (i.next()) \{
    \mbox{\hyperlink{group__string__functions_ga32070517a9f8a70a32ef48f83a6f128e}{printf}}(\textcolor{stringliteral}{"+ %y\(\backslash\)n"}, i.getValue());
\}
\end{DoxyCode}

\end{DoxyParagraph}

\begin{DoxyExceptions}{Exceptions}
{\em I\+T\+E\+R\+A\+T\+O\+R-\/\+E\+R\+R\+OR} & the iterator is not pointing at a valid element \\
\hline
{\em I\+T\+E\+R\+A\+T\+O\+R-\/\+T\+H\+R\+E\+A\+D-\/\+E\+R\+R\+OR} & this exception is thrown if this method is called from any thread other than the thread that created the object\\
\hline
\end{DoxyExceptions}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{class_qore_1_1_input_stream_line_iterator_a97843613b1efffb8191a982b034ad35e}{Input\+Stream\+Line\+Iterator\+::get\+Line()}} 
\end{DoxySeeAlso}


Implements \mbox{\hyperlink{class_qore_1_1_abstract_line_iterator_acc1342afce2820c3d1dded7aeb2b8dd8}{Qore\+::\+Abstract\+Line\+Iterator}}.

\mbox{\Hypertarget{class_qore_1_1_input_stream_line_iterator_ac2a16a29cd14271505149e96c144c814}\label{class_qore_1_1_input_stream_line_iterator_ac2a16a29cd14271505149e96c144c814}} 
\index{Qore\+::\+Input\+Stream\+Line\+Iterator@{Qore\+::\+Input\+Stream\+Line\+Iterator}!index@{index}}
\index{index@{index}!Qore\+::\+Input\+Stream\+Line\+Iterator@{Qore\+::\+Input\+Stream\+Line\+Iterator}}
\subsubsection{\texorpdfstring{index()}{index()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} Qore\+::\+Input\+Stream\+Line\+Iterator\+::index (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Returns the current iterator line number in the data (the first line is line 1) or 0 if not pointing at a valid element. 

\begin{DoxyReturn}{Returns}
the current iterator line number in the data (the first line is line 1) or 0 if not pointing at a valid element
\end{DoxyReturn}
\begin{DoxyParagraph}{Code Flags\+:}
\mbox{\hyperlink{code_flags_CONSTANT}{C\+O\+N\+S\+T\+A\+NT}}
\end{DoxyParagraph}
\begin{DoxyParagraph}{Example\+:}

\begin{DoxyCode}
\textcolor{keywordflow}{while} (i.next()) \{
    \mbox{\hyperlink{group__string__functions_ga32070517a9f8a70a32ef48f83a6f128e}{printf}}(\textcolor{stringliteral}{"+ %d: %y\(\backslash\)n"}, i.index(), i.getValue());
\}
\end{DoxyCode}
 
\end{DoxyParagraph}


Implements \mbox{\hyperlink{class_qore_1_1_abstract_line_iterator_acde61f19ac0b96adcaafbe4962e9a335}{Qore\+::\+Abstract\+Line\+Iterator}}.

\mbox{\Hypertarget{class_qore_1_1_input_stream_line_iterator_a15869ee0a81ae224334f83f681b6e760}\label{class_qore_1_1_input_stream_line_iterator_a15869ee0a81ae224334f83f681b6e760}} 
\index{Qore\+::\+Input\+Stream\+Line\+Iterator@{Qore\+::\+Input\+Stream\+Line\+Iterator}!next@{next}}
\index{next@{next}!Qore\+::\+Input\+Stream\+Line\+Iterator@{Qore\+::\+Input\+Stream\+Line\+Iterator}}
\subsubsection{\texorpdfstring{next()}{next()}}
{\footnotesize\ttfamily bool Qore\+::\+Input\+Stream\+Line\+Iterator\+::next (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Moves the current position to the next line in the data; returns \mbox{\hyperlink{group__boolean__constants_ga9da2b9a8003cd3788e48305f8a00540f}{False}} if there are no more lines to read; if the iterator is not pointing at a valid element before this call, the iterator will be positioned to the beginning of the data. 

The iterator object should not be used after this method returns \mbox{\hyperlink{group__boolean__constants_ga9da2b9a8003cd3788e48305f8a00540f}{False}}.

\begin{DoxyReturn}{Returns}
\mbox{\hyperlink{group__boolean__constants_ga9da2b9a8003cd3788e48305f8a00540f}{False}} if there are no more lines in the data (in which case the iterator object is invalid and should not be used); \mbox{\hyperlink{group__boolean__constants_ga3ba2df91713a6249449347131ea526c3}{True}} if successful (meaning that the iterator object is valid)
\end{DoxyReturn}
\begin{DoxyParagraph}{Example\+:}

\begin{DoxyCode}
\textcolor{keywordflow}{while} (i.next()) \{
    \mbox{\hyperlink{group__string__functions_ga32070517a9f8a70a32ef48f83a6f128e}{printf}}(\textcolor{stringliteral}{"line: %y\(\backslash\)n"}, i.getValue());
\}
\end{DoxyCode}

\end{DoxyParagraph}

\begin{DoxyExceptions}{Exceptions}
{\em I\+T\+E\+R\+A\+T\+O\+R-\/\+T\+H\+R\+E\+A\+D-\/\+E\+R\+R\+OR} & this exception is thrown if this method is called from any thread other than the thread that created the object \\
\hline
\end{DoxyExceptions}


Implements \mbox{\hyperlink{class_qore_1_1_abstract_line_iterator_ac5f7742a325b335f3cd2ab0bb5f37272}{Qore\+::\+Abstract\+Line\+Iterator}}.

\mbox{\Hypertarget{class_qore_1_1_input_stream_line_iterator_ad67679ac159cec3362a5faed21f0dcdb}\label{class_qore_1_1_input_stream_line_iterator_ad67679ac159cec3362a5faed21f0dcdb}} 
\index{Qore\+::\+Input\+Stream\+Line\+Iterator@{Qore\+::\+Input\+Stream\+Line\+Iterator}!valid@{valid}}
\index{valid@{valid}!Qore\+::\+Input\+Stream\+Line\+Iterator@{Qore\+::\+Input\+Stream\+Line\+Iterator}}
\subsubsection{\texorpdfstring{valid()}{valid()}}
{\footnotesize\ttfamily bool Qore\+::\+Input\+Stream\+Line\+Iterator\+::valid (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Returns \mbox{\hyperlink{group__boolean__constants_ga3ba2df91713a6249449347131ea526c3}{True}} if the iterator is currently pointing at a valid element, \mbox{\hyperlink{group__boolean__constants_ga9da2b9a8003cd3788e48305f8a00540f}{False}} if not. 

\begin{DoxyReturn}{Returns}
\mbox{\hyperlink{group__boolean__constants_ga3ba2df91713a6249449347131ea526c3}{True}} if the iterator is currently pointing at a valid element, \mbox{\hyperlink{group__boolean__constants_ga9da2b9a8003cd3788e48305f8a00540f}{False}} if not
\end{DoxyReturn}
\begin{DoxyParagraph}{Code Flags\+:}
\mbox{\hyperlink{code_flags_CONSTANT}{C\+O\+N\+S\+T\+A\+NT}}
\end{DoxyParagraph}
\begin{DoxyParagraph}{Example\+:}

\begin{DoxyCode}
\textcolor{keywordflow}{if} (i.valid())
    \mbox{\hyperlink{group__string__functions_ga32070517a9f8a70a32ef48f83a6f128e}{printf}}(\textcolor{stringliteral}{"current value: %y\(\backslash\)n"}, i.getValue());
\end{DoxyCode}
 
\end{DoxyParagraph}


Implements \mbox{\hyperlink{class_qore_1_1_abstract_line_iterator_a06fc51d01bfae9f17f290ac247ffd3f3}{Qore\+::\+Abstract\+Line\+Iterator}}.

