/ 
File-Record-0.01
River stage zero No dependents
/ File::Record

NAME

File::Record - Read file by record!

VERSION

Version 0.01

SYNOPSIS

use File::Record;

my $reader = File::Record->new(
    mode => 'start',
    filehandle => $fh,
    pattern => qr/^\S/
);

or

my $reader = File::Record->new();
$reader->mode('start');
$reader->filehandle('$fh');
$reader->pattern(qr/^\S/);

while (my $record = $reader->next_record()){
    ...
}

DESCRIPTION

Usually the file we are working on contains many records, which consist of several line, and we want to read the file record by record instead of line by line. For record with explicit terminator, we can easily do that by set the input record separator ($/) to that terminator. But for record with no explicit terminator, we can only do that by testing the next line.

This module allows you to define the record and read the file record by record.

METHODS

new

The constructor takes key/value pairs to set the behavior of file reader to be created.

#Defalt simulate the diamond operator <>.
my $reader = File::Record->new();
while ($reader->next_record){
    ...
}

equal to

while (<>){
    ...
}

#Specify the pattern to identify the marker line 
my $reader = File::Record->new(pattern => "^\t");

To identify the marker line of a record, a regular expression is needed. By default, the $/ is used to simulate the diamond operator <>.

next_record

my $record = $reader->next_record();

Return one $record based on current $reader.

mode

default_mode

pattern

my $pattern = $reader->pattern;
$reader->pattern("^\t");

Getter/setter for pattern.

default_pattern

filehandle

my $fh = $reader->filehandle;
$reader->filehandle($fh);

Getter/setter for filehandle.

default_filehandle

AUTHOR

freedog, <freedog at cpan.org>

BUGS

Please report any bugs or feature requests to bug-file-record at rt.cpan.org, or through the web interface at https://rt.cpan.org/NoAuth/ReportBug.html?Queue=File-Record. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc File::Record

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2019 freedog.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.