NAME
Directory::Iterator - Simple, efficient recursive directory listing
SYNOPSIS
use Directory::Iterator;
my $it = Directory::Iterator->new($dir);
while (my $file = <$it>) {
print "$file\n";
}DESCRIPTION
This is a simple, efficient way to get a recursive list of all files under a specified directory.
It implements a typical iterator interface, making it simple to convert code that processes a list of files to use this instead. The directory is read as the list is consumed, so memory overhead is minimal.
This module simply loads the appropriate backend; either Directory::Iterator::PP or Directory::Iterator::XS. With the pure-perl backend, the speed is equivalent to File::Find; the XS backend is a few times faster.
METHODS
- next()
-
Advance to the next file and return its name; returns undef after all names have been read. This is the underlying method for the <> operator.
- get()
-
Return the latest file name without advance to the next file; returns undef after all names have been read. This is the underlying method for the "" operator.
- prune()
-
Close the directory that is currently being read, so no more files from it will be returned.
As currently implemented, it's possible that some subdirectories could've been queued before the first file was seen, so it's not guaranteed that a single call to prune will always suffice. Its purpose is simply to be more efficient than continuing to read files from an unwanted directory.
- show_dotfiles(ARG)
-
If ARG is true, hidden files & directories, those with names that begin with a . will be processed as regular files. By default, such files are skipped.
EXPORT
None by default.
SEE ALSO
AUTHOR
Steve Sanbeg
COPYRIGHT AND LICENSE
Copyright (C) 2012 by Steve Sanbeg
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.10.1 or, at your option, any later version of Perl 5 you may have available.