# Data::Stream::Bulk::Path::Class - phpMan

## NAME
    [Data::Stream::Bulk::Path::Class] - [Path::Class::Dir] traversal

## VERSION
    version 0.11

## SYNOPSIS
            use [Data::Stream::Bulk::Path::Class];

            my $dir = [Data::Stream::Bulk::Path::Class]->new(
                    dir => [Path::Class::Dir]->new( ... ),
            );

## DESCRIPTION
    This stream produces depth or breadth first traversal order recursion
    through [Path::Class::Dir] objects.

    Items are read iteratively, and a stack of open directory handles is
    used to keep track of state.

## ATTRIBUTES
    chunk_size
        Defaults to 250.

    depth_first
        Chooses between depth first and breadth first traversal order.

    only_files
        If true only [Path::Class::File] items will be returned in the output
        streams (no directories).

## METHODS
    is_done
        Returns true when no more files are left to iterate.

    next
        Returns the next chunk of [Path::Class] objects

## AUTHOR
    Yuval Kogman <<nothingmuch@woobling.org>>

## COPYRIGHT AND LICENSE
    This software is copyright (c) 2012 by Yuval Kogman.

    This is free software; you can redistribute it and/or modify it under
    the same terms as the Perl 5 programming language system itself.