File::Truncate::Undoable - Truncate a file, with undo support
This document describes version 0.05 of File::Truncate::Undoable (from Perl distribution File-Truncate-Undoable), released on 2017-07-10.
Usage:
truncate(%args) -> [status, msg, result, meta]
Truncate a file, with undo support.
On do, will trash file then create an empty file (with the same permission and ownership as the original). On undo, will trash the new file and untrash the old file.
Note: chown will not be done if we are not running as root. Symlink is currently not permitted.
Fixed state: file exists and size is not zero.
Fixable state: file exists and size is not zero.
Unfixable state: file does not exist or path is not a regular file (directory and symlink included).
This function is not exported.
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
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-Truncate-Undoable.
Source repository is at https://github.com/perlancar/perl-File-Truncate-Undoable.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=File-Truncate-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.
Rinci::Transaction
perlancar <perlancar@cpan.org>
This software is copyright (c) 2017, 2015, 2014, 2012 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::Truncate::Undoable, copy and paste the appropriate command in to your terminal.
cpanm
cpanm File::Truncate::Undoable
CPAN shell
perl -MCPAN -e shell install File::Truncate::Undoable
For more information on module installation, please visit the detailed CPAN module installation guide.