README
1Iterator::IO version 0.02
2=========================
3
4This module provides some file and filesystem iterators.
5
6See the "Iterator" module for more information on what an iterator
7is, and how to use it.
8
9
10EXAMPLES
11
12Read a file, line by line:
13
14 $fh = ifile ($filename);
15 while ($fh->isnt_exhausted)
16 {
17 $line = $fh->value;
18 # do something with $line
19 }
20
21Read a file, line by line, in reverse order:
22
23 $fh = ifile_reverse ($filename);
24 while ($fh->isnt_exhausted)
25 {
26 $line = $fh->value;
27 # do something with $line
28 }
29
30Read a directory listing, entry by entry:
31
32 $dh = idir_listing ($path);
33 while ($dh->isnt_exhausted)
34 {
35 $filename = $dh->value;
36 # do something with $filename
37 }
38
39DEVELOPMENT STATE
40
41This is a brand-new module. It has a decent test suite, but has
42not been extensively field-tested. Therefore, it should be considered
43"beta" software, and used with care.
44
45If you find any bugs, or if any behavior of Iterator surprises you,
46I would be grateful if you could send me an email message about it.
47Thanks.
48
49
50INSTALLATION
51
52To install this module, do the standard Perl module four-step:
53
54 perl Makefile.PL or perl Makefile.pl LIB='my/install/path'
55 make
56 make test
57 make install
58
59DEPENDENCIES
60
61This module requires these other modules and libraries:
62
63 Iterator
64
65COPYRIGHT AND LICENSE
66
67Eric J. Roode, roode@cpan.org
68
69To avoid my spam filter, please include "Perl", "module", or this
70module's name in the message's subject line, and/or GPG-sign your
71message.
72
73Copyright (c) 2005 by Eric J. Roode. All Rights Reserved.
74This module is free software; you can redistribute it and/or modify it
75under the same terms as Perl itself.
76