NAME

App::Ack::Resource

DESCRIPTION

Abstracts a file from the filesystem.

METHODS

new( $filename )

Opens the file specified by $filename and returns a filehandle and a flag that says whether it could be binary.

If there's a failure, it throws a warning and returns an empty list.

$res->name()

Returns the name of the resource.

$res->basename()

Returns the basename (the last component the path) of the resource.

$res->open()

Opens a filehandle for reading this resource and returns it, or returns undef if the operation fails (the error is in $!). Instead of calling close $fh, $res->close should be called.

$res->needs_line_scan( \%opts )

Tells if the file needs a line-by-line scan. This is a big optimization because if you can tell from the outset that the pattern is not found in the resource at all, then there's no need to do the line-by-line iteration.

Slurp up an entire file up to 100K, see if there are any matches in it, and if so, let us know so we can iterate over it directly. If it's bigger than 100K or the match is inverted, we have to do the line-by-line, too.

$res->reset()

Resets the resource back to the beginning. This is only called if needs_line_scan() is true, but not always if needs_line_scan() is true.

$res->close()

Close the file.

$res->clone()

Clones this resource.

$res->firstliney()

Returns the first line of a file (or first 250 characters, whichever comes first).