File Coverage

lib/App/GitFind/Searcher.pm

Criterion	Covered	Total	%
statement	14	17	82.3
branch	0	4	0.0
condition			n/a
subroutine	5	6	83.3
pod	1	1	100.0
total	20	28	71.4

# App::GitFind::Searcher - Search for files in a scope - abstract base class
package App::GitFind::Searcher;

use 5.010;
use strict;
use warnings;

our $VERSION = '0.000002';

use parent 'App::GitFind::Class';
#use Class::Tiny qw(TODO);

use App::GitFind::Base;

# Docs {{{1

=head1 NAME

App::GitFind::Searcher - Search for files in a particular scope

=head1 SYNOPSIS

This is an abstract base class.  Subclasses search for files in
particular scopes.

=cut

# }}}1

=head1 FUNCTIONS

=head2 run

Conducts a search.  Usage:

    $searcher->run(sub { ... });

The only parameter is a callback that will be invoked as:

    $callback->(TODO);

TODO pruning, cancelling?

=cut

sub run {
    my $self = shift or (require Carp, Carp::croak 'Need an instance');
    my $callback = shift or (require Carp, Carp::croak 'Need a callback');
    ...
} #run()

1;
__END__
# vi: set fdm=marker: #