Iterator(3)

🌸 NAME 🌸

okay bestie, this is the Iterator(3) page — User Contributed Perl Documentation — and the module is Find::File::Iterator - Iterator interface for search files ✨

---

✨ SYNOPSIS ✨

use File::Find::Iterator;
my $find = File::Find::Iterator->create(dir => ["/home", "/var"],
                                        filter => \&isdir);
sub isdir { -d }

while (my $f = $find->next) { print "file : $f\n" }

#reread with different filter
$find->filter(\&ishtml);
$find->first;
while (my $f = $find->next) { print "file : $f\n" }

sub ishtml { /\.html?$/ }

# using file for storing state
$find->statefile($statefile);
$find->first;
# this time it could crash
while (my $f = $find->next)
{ print "file : $f\n" }

# using imap and igrep
use File::Find::Iterator qw(imap igrep);
my $find = File::Find::Iterator->new(dir => ["/home", "/var"]);
$find = imap { -M } igrep { -d } $find;

💖 DESCRIPTION 💖

Find::File::Iterator is an iterator object for searching through directory trees. You can easily run a filter on each file name, and you can easily save the search state when you want to stop the search and continue the same search later. slay 💅

Find::File::Iterator inherits from Class::Iterator, so you can use the imap and the igrep constructor. 🫶

🛠️ create(%opt)

This is the constructor. The %opt hash accepts the following keys:

• dir "=> \@dir" — takes a reference to a list of directories.
• filter "=> \&code" — takes a code reference.
• statefile "=> $file" — takes a filename.

🔁 next

Calling this method makes one iteration. It returns the file name, or "undef" if there is no more work to do. 💀

🥇 first

Calling this method makes an initialisation of the iterator. You can use it to do a search again, but with some little change (directory root, statefile option, different filter). ✨

📁 dir([ \@dir ])

This method gets or sets the directory list for the search.

🎛️ filter([ \&code ])

This method gets or sets the filter method used by the next method.

💾 statefile([ $file ])

This method gets or sets the name of the file used to store state of the search (see "STORING STATE").

---

🎀 STORING STATE 🎀

If the statefile option of the constructor or the statefile field of the object is set, the iterator uses the Storable module to record its internal state after one iteration and to set its internal state before a new iteration. With this mechanism you can continue your search after an error occurred. iykyk 😭

---

🦋 SEE ALSO 🦋

• Class::Iterator

---

🌈 CREDITS 🌈

Shoutout to Marc Jason Dominius's YAPC::EU 2003 classes. 👑

---

👑 AUTHOR 👑

Robert Silve <robert@silve.net>

---

mwah 💋 this page is from perl v5.32.1, dated 2022-01-12, and it's the Iterator(3) footer — bye bestie 🎀