NAME
Log::Deep::File - Object for keeping track of info related to a log file.
VERSION
This documentation refers to Log::Deep::File version 0.3.5.
SYNOPSIS
use Log::Deep::File;
# Create a new object
my $file = Log::Deep::File->new('deep.log');
# read the log file
while ( my $line = $file->line ) {
# so stuff
...
}
# use the file name in a string
print "Finished reading the file '$file'\n";
# reset the handle so that we can start again
$file->reset;DESCRIPTION
SUBROUTINES/METHODS
new ( $name )
Param: $name - string - The log file name to be tracked
Return: Log::Deep::File - A new object
Description: Creates a new object and opens the specified file.
line ( )
Return: The next line read from the log file or undef if the end of the file has been reached
Description: Reads the next line of the log file.
name ( )
Return: The name of the log file
reset ( )
Description: Resets the file handle so that it can be attempted to be read again at a later time.
DIAGNOSTICS
CONFIGURATION AND ENVIRONMENT
DEPENDENCIES
INCOMPATIBILITIES
BUGS AND LIMITATIONS
There are no known bugs in this module.
Please report problems to Ivan Wills (ivan.wills@gmail.com).
Patches are welcome.
AUTHOR
Ivan Wills - (ivan.wills@gmail.com)
LICENSE AND COPYRIGHT
Copyright (c) 2009 Ivan Wills (14 Mullion Close, Hornsby Heights, NSW Australia 2077). All rights reserved.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.