|
| constructor (string path, *string encoding, *string eol, bool trim=True) |
| opens the given file for reading with the given options and creates the FileLineIterator object More...
|
|
| copy () |
| Creates a new FileLineIterator object, based on the same object being iterated in the original object (the original file is reopened) More...
|
|
string | getEncoding () |
| Returns the character encoding for the FileLineIterator. More...
|
|
string | getFileName () |
| returns the file path/name used to open the file More...
|
|
string | getLine () |
| returns the current line in the file or throws an INVALID-ITERATOR exception if the iterator is invalid More...
|
|
int | getPos () |
| Returns the current file position as an integer giving the offset in bytes from the beginning of the file (starting from zero) More...
|
|
string | getValue () |
| returns the current line in the file or throws an INVALID-ITERATOR exception if the iterator is invalid More...
|
|
int | index () |
| returns the current iterator line number in the file (the first line is line 1) or 0 if not pointing at a valid element More...
|
|
bool | isTty () |
| returns True if the FileLineIterator is connected to a terminal device, False if not More...
|
|
bool | next () |
| Moves the current position to the next line in the file; returns 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 file. More...
|
|
| reset () |
| Reset the iterator instance to its initial state. More...
|
|
bool | valid () |
| returns True if the iterator is currently pointing at a valid element, False if not More...
|
|
This class defines a line iterator for text files.
- Since
- Qore 0.8.6
- Restrictions:
- Qore::PO_NO_FILESYSTEM
- Example: FileLineIterator basic usage
file content:
a2ps-4.13-1332.1.x86_64
a2ps-devel-4.13-1332.1.x86_64
aaa_base-11.3-7.2.x86_64
...
my FileLineIterator $it("/export/home/pvanek/ren.list");
while ($it.next()) {
printf(
"%s:%d = %n\n", $it.getFileName(), $it.index(), $it.getValue());
}
/export/home/pvanek/ren.list:1 = "a2ps-4.13-1332.1.x86_64"
/export/home/pvanek/ren.list:2 = "a2ps-devel-4.13-1332.1.x86_64"
/export/home/pvanek/ren.list:3 = "aaa_base-11.3-7.2.x86_64"
...
/export/home/pvanek/ren.list:2155 = "zypper-1.4.5-1.10.x86_64"
bool Qore::FileLineIterator::next |
( |
| ) |
|
|
virtual |
Moves the current position to the next line in the file; returns 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 file.
This method will return True again after it returns False once if file is not empty, otherwise it will always return False The iterator object should not be used after this method returns False
- Returns
- False if there are no more lines in the file (in which case the iterator object is invalid and should not be used); True if successful (meaning that the iterator object is valid)
- Example:
while ($i.next()) {
printf(
"line: %y\n", $i.getValue());
}
- Exceptions
-
ITERATOR-THREAD-ERROR | this exception is thrown if this method is called from any thread other than the thread that created the object |
Implements Qore::AbstractIterator.