Andy Lester > ack > App::Ack::Resource

Download:
ack-2.14.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Source  

SYNOPSIS ^

This is the base class for App::Ack::Resource and any resources that derive from it.

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->is_binary()

Tells whether the resource is binary. If it is, and ack finds a match in the file, then ack will not try to display a match line.

$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 )

API: Tells if the resource 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. If in doubt, return true.

Base: 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()

API: Close the resource.

$res->clone

Clones this resource.

$res->firstliney

Returns the first line (or first 250 characters, whichever comes first of a resource). Resource subclasses are encouraged to cache this value.

syntax highlighting: