view release on metacpan or  search on metacpan

README  view on Meta::CPAN

            foo/a           bar/a
            foo/b/c         bar/d/e

        the iterator would return

            .
            a
            b
            d
            b/c
            d/e

        That is it returns the list of names that would result if foo was
        copied over bar and then bar scanned. Note that the starting
        directory '.' is returned.

        Directories are searched in breadth first order.

    "all_iterator"
        Get an iterator that will return the names of all the files and
        directories that are in the intersection of the directories to be
        scanned.

        Given directories like this

            foo             bar
            foo/a           bar/a
            foo/b/c         bar/d/e

        the iterator would return

            .
            a

        That is it returns the names of those files and directories that can
        be found in both foo and bar.

    "want_iterator( $threshold )"
        Returns an iterator that returns all files and directories for which
        there are at least the specified number of instances across all
        directories being scanned. For example if you are scanning three
        directories and you need to perform some operation whenever a
        particular file is found in two or more of them:

            my $ffp = File::Find::Parallel->new( $dir1, $dir2, $dir3 );
            my $iter = $ffp->want_iterator( 2 );

            while ( my $obj = $iter->() ) {
                print "We have at least two copies of $obj\n";
            }

        This is the primitive on which "all_iterator" and "any_iterator" are
        built.

DEPENDENCIES
    The tests require File::Temp and optionally Test::Pod::Coverage and
    Test::Pod.

    The lncopies script requires Getopt::Long and Pod::Usage.

BUGS AND LIMITATIONS
    I haven't checked but it must be slower than File::Find. Use that
    instead if you only want to scan a single directory at a time.

    Please report any bugs or feature requests to
    "bug-file-find-parallel@rt.cpan.org", or through the web interface at
    <http://rt.cpan.org>.

AUTHOR
    Andy Armstrong "<andy@hexten.net>"

LICENCE AND COPYRIGHT
    Copyright (c) 2007-2008, Andy Armstrong "<andy@hexten.net>". All rights
    reserved.

    This module is free software; you can redistribute it and/or modify it
    under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY
    BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
    FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
    OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
    PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
    EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
    ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
    YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
    NECESSARY SERVICING, REPAIR, OR CORRECTION.

    IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
    WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
    REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE
    TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
    CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
    SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
    RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
    FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
    SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
    DAMAGES.