File::Prepend::Undoable - Prepend string to a file, with undo support
This document describes version 0.03 of File::Prepend::Undoable (from Perl distribution File-Prepend-Undoable), released on 2015-08-17.
Rinci::Transaction
{en_US Prepend string to a file, with undo support}.
{en_US 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:
Chown will not be done if we are not running as root.
Symlink is currently not permitted.
Since transaction requires the function to be idempotent, in the check_state phase the function will check if the string has been prepended. It will refuse to prepend the same string twice.
check_state
Take care not to use string that are too large, as the string, being a function parameter, is entered into the transaction table.
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):
path* => str
{en_US The file to prepend}.
string* => any
{en_US The string to prepend to file}.
Special arguments:
-tx_action => str
For more information on transaction, see Rinci::Transaction.
-tx_action_id => str
-tx_recovery => str
-tx_rollback => str
-tx_v => str
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.
Return value: (any)
Please visit the project's homepage at https://metacpan.org/release/File-Prepend-Undoable.
Source repository is at https://github.com/sharyanto/perl-File-Prepend-Undoable.
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.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2015 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install File::Prepend::Undoable, copy and paste the appropriate command in to your terminal.
cpanm
cpanm File::Prepend::Undoable
CPAN shell
perl -MCPAN -e shell install File::Prepend::Undoable
For more information on module installation, please visit the detailed CPAN module installation guide.