Manuel Subredu > Rsync-Config-0.3.1 > Rsync::Config::Parser

Download:
Rsync-Config-0.3.1.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 0.1   Source  

NAME ^

Rsync::Config::Parser

VERSION ^

0.1

DESCRIPTION ^

Rsync::Config::Parser is used to parse a existing rsync configuration file.

SYNOPSIS ^

 use Rsync::Config::Parser;
 use Rsync::Config;

 sub main {
   my $parser = new Rsync::Config::Parser();
   
   my $conf = $parser->parse('/etc/rsyncd.conf');
 }

SUBROUTINES/METHODS ^

new()

Class constructor. Accepts a hash with the following options:

eat_trail_spaces (def. 0)

Removes the trail spaces from all lines.

parse($filename, $opt)

Calls the parser. You can override the defaults options by giving a hash ref ($opt). Returns a Rsync::Config object.

eat_trail_spaces

    my $eat_trails = $parser->eat_trail_spaces;
    $parser->eat_trail_spaces(1);

Both accessor and mutator, eat_trail_spaces can be used to get the current value or to change it.

If no arguments are provided, it will return the current eat_trail_spaces value.

If arguments are provided, first is considered to be the new eat_trail_spaces value and applied to the current object, all others being ignored.

As mutator, the current object will be returned (useful for method chaining).

If invalid value is passed , a fatal error is threw. Valid values are non-negative integers (0 included).

It can also be called as a class method, returning the default eat_trail_spaces value. In this case, no mutator mode is possible.

DEPENDENCIES ^

Rsync::Config::Atom depends on the following modules:

English
Scalar::Util
CLASS

DEPENDENCIES ^

Exception::Class, CLASS.

DIAGNOSTICS ^

Rsync::Config::Parser::File

Occurs when the file could not be opened.

Rsync::Config::Parser::InvalidTrailSpaces

Occurs when eat_trail_spaces is called with invalid parameter

CONFIGURATION AND ENVIRONMENT ^

This module does not use any configuration files or environment variables.

INCOMPATIBILITIES ^

None known to the author.

BUGS AND LIMITATIONS ^

No bugs known to the author.

SEE ALSO ^

Rsync::Config.

AUTHOR ^

Manuel SUBREDU <diablo@packages.ro>.

LICENSE AND COPYRIGHT ^

Copyright (c) 2006, Manuel SUBREDU <diablo@packages.ro>. 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.

DISCLAIMER OF WARRANTY ^

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

syntax highlighting: