Steven Haryanto > File-Prepend-Undoable-0.02 > File::Prepend::Undoable

Download:
File-Prepend-Undoable-0.02.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.02   Source  

NAME ^

File::Prepend::Undoable - Prepend string to a file, with undo support

VERSION ^

This document describes version 0.02 of File::Prepend::Undoable (from Perl distribution File-Prepend-Undoable), released on 2014-05-17.

FUNCTIONS ^

prepend(%args) -> [status, msg, result, meta]

Prepend string to a file, with undo support.

On do, will trash file, copy it to original location (with the same permission and ownership as the original) and prepend the string to the beginning of file. On undo will trash the new file and untrash the original.

Some notes:

Fixed state: file exists and string has been prepended to beginning of file.

Fixable state: file exists and string has not been prepended to beginning of file.

Unfixable state: file does not exist or path is not a regular file (directory and symlink included).

This function is idempotent (repeated invocations with same arguments has the same effect as single invocation). This function supports transactions.

Arguments ('*' denotes required arguments):

Special arguments:

Return value:

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

SEE ALSO ^

Rinci::Transaction

HOMEPAGE ^

Please visit the project's homepage at https://metacpan.org/release/File-Prepend-Undoable.

SOURCE ^

Source repository is at https://github.com/sharyanto/perl-File-Prepend-Undoable.

BUGS ^

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=File-Prepend-Undoable

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR ^

Steven Haryanto <stevenharyanto@gmail.com>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2014 by Steven Haryanto.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: