File::Find::Object::Result(3pm) User Contributed Perl Documentation File::Find::Object::Result(3pm)NAME
File::Find::Object::Result - a result class for File::Find::Object
DESCRIPTION
This is a class returning a single File::Find::Object result as returned by its next_obj() method.
METHODS
File::Find::Object::Result->new({%args});
Initializes a new object from %args. For internal use.
$result->base()
Returns the base directory from which searching began.
$result->path()
Returns the full path of the result. As such "$ffo->next_obj()->path()" is equivalent to "$ffo->next()" .
$result->is_dir()
Returns true if the result refers to a directory.
$result->is_file()
Returns true if the result refers to a plain file (equivalent to the Perl "-f" operator).
$result->is_link()
Returns true if the result is a symbolic link.
$result->dir_components()
The components of the directory part of the path starting from base() (also the full path if the result is a directory) as an array
reference.
$result->basename()
Returns the basename of the file (if it is a file and not a directory.) Otherwise - undef().
$result->full_components()
Returns the full components of the result with the basename if it is a file.
$result->stat_ret()
The return value of "stat" in perlfunc for the result, placed inside an array reference. This is calculated by File::Find::Object and kept
here for convenience and for internal use.
SEE ALSO
File::Find::Object
LICENSE
Copyright (C) 2005, 2006 by Olivier Thauvin
This package is free software; you can redistribute it and/or modify it under the following terms:
1. The GNU General Public License Version 2.0 - http://www.opensource.org/licenses/gpl-license.php
2. The Artistic License Version 2.0 - http://www.perlfoundation.org/legal/licenses/artistic-2_0.html
3. At your option - any later version of either or both of these licenses.
perl v5.10.0 2009-06-18 File::Find::Object::Result(3pm)
Check Out this Related Man Page
Wanted(3pm) User Contributed Perl Documentation Wanted(3pm)NAME
File::Find::Wanted - More obvious wrapper around File::Find
VERSION
Version 1.00
SYNOPSIS
File::Find is a great module, except that it doesn't actually find anything. Its "find()" function walks a directory tree and calls a
callback function. Unfortunately, the callback function is deceptively called "wanted", which implies that it should return a boolean
saying whether you want the file. That's not how it works.
Most of the time you call "find()", you just want to build a list of files. There are other modules that do this for you, most notably
Richard Clamp's great File::Find::Rule, but in many cases, it's overkill, and you need to learn a new syntax.
With the "find_wanted" function, you supply a callback sub and a list of starting directories, but the sub actually should return a boolean
saying whether you want the file in your list or not.
To get a list of all files ending in .jpg:
my @files = find_wanted( sub { -f && /.jpg$/ }, $dir );
For a list of all directories that are not CVS or .svn:
my @files = find_wanted( sub { -d && !/^(CVS|.svn)$/ }, $dir ) );
It's easy, direct, and simple.
WHY DO THIS ?
The cynical may say "that's just the same as doing this":
my @files;
find( sub { push @files, $File::Find::name if -f && /.jpg$/ }, $dir );
Sure it is, but File::Find::Wanted makes it more obvious, and saves a line of code. That's worth it to me. I'd like it if find_wanted()
made its way into the File::Find distro, but for now, this will do.
FUNCTIONS
find_wanted( &wanted, @directories )
Descends through @directories, calling the wanted function as it finds each file. The function returns a list of all the files and
directories for which the wanted function returned a true value.
This is just a wrapper around "File::Find::find()". See File::Find for details on how to modify its behavior.
COPYRIGHT &; LICENSE
Copyright 2005-2012 Andy Lester.
This program is free software; you can redistribute it and/or modify it under the terms of the Artistic License v2.0.
perl v5.14.2 2012-06-08 Wanted(3pm)