perlancar

NAME

File::Truncate::Undoable - Truncate a file, with undo support

VERSION

This document describes version 0.03 of File::Truncate::Undoable (from Perl distribution File-Truncate-Undoable), released on 2015-08-17.

SEE ALSO

Rinci::Transaction

FUNCTIONS

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

{en_US Truncate a file, with undo support}.

{en_US 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 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:

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)

HOMEPAGE

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

SOURCE

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

BUGS

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

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.