/ 
Directory-Scanner-0.02
River stage zero No dependents
/ Directory::Scanner::API::Stream

NAME

Directory::Scanner::API::Stream - Streaming directory iterator abstract interface

VERSION

version 0.02

DESCRIPTION

This is a simple API role that defines what a stream object can do.

METHODS

next

Get the next item in the stream.

The value currently being processed. This is always the same as the last value returned from next.

is_done

This indicates that the stream has been exhausted and that there is no more values to come from next.

This occurs *after* the last call to next that returned nothing.

close

This closes a stream and any subsequent calls to next will throw an error.

is_closed

This indicates that the stream has been closed, usually by someone calling the close method.

clone( ?$dir )

This will clone a given stream and can optionally be given a different directory to scan.

flatten

This will take a given stream and flatten it into an array.

AUTHOR

Stevan Little <stevan@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by Stevan Little.

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