File::Trash::Undoable - Trash files, with undo/redo capability
This document describes version 0.230 of File::Trash::Undoable (from Perl distribution File-Trash-Undoable), released on 2020-06-03.
# use the trash-u script
This module provides routines to trash files, with undo/redo support. Actual trashing/untrashing is provided by File::Trash::FreeDesktop.
empty_trash() -> [status, msg, payload, meta]
This function is not exported.
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 (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
list_trash_contents() -> [status, msg, payload, meta]
List contents of trash directory.
trash(%args) -> [status, msg, payload, meta]
Trash a file.
Fixed state: path does not exist.
Fixable state: path exists.
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
suffix => str
-tx_action => str
For more information on transaction, see L<Rinci::Transaction>.
-tx_action_id => str
-tx_recovery => str
-tx_rollback => str
-tx_v => str
trash_files(%args) -> [status, msg, payload, meta]
Trash files (with undo support).
files* => array[str]
Files/dirs to delete.
Files must exist.
untrash(%args) -> [status, msg, payload, meta]
Untrash a file.
Fixed state: path exists.
Fixable state: Path does not exist (and exists in trash, and if suffix is specified, has the same suffix).
Please visit the project's homepage at https://metacpan.org/release/File-Trash-Undoable.
Source repository is at https://github.com/perlancar/perl-File-Trash-Undoable.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=File-Trash-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.
A command-line utility, part of the GNOME project.
A Python-based command-line application. Also follows freedesktop.org trash specification.
A bash script. Features undo ("rollback"). At the time of this writing, does not support per-filesystem trash (everything goes into home trash).
This software is copyright (c) 2020, 2017, 2016, 2015, 2014, 2013, 2012 by firstname.lastname@example.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::Trash::Undoable, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell
For more information on module installation, please visit the detailed CPAN module installation guide.