NAME
File::Util::DirList - File utilities involving a list of directories
VERSION
This document describes version 0.002 of File::Util::DirList (from Perl
distribution File-Util-DirList), released on 2023-11-20.
FUNCTIONS
mv_files_to_dirs
Usage:
mv_files_to_dirs(%args) -> [$status_code, $reason, $payload, \%result_meta]
Move files to directories, one file to each directory.
Examples:
* Move f1 to d1, f2 to d2, f3 to d3:
mv_files_to_dirs(files_then_dirs => ["f1", "f2", "f3", "d1", "d2", "d3"]);
This function is not exported by default, but exportable.
This function supports dry-run operation.
Arguments ('*' denotes required arguments):
* files_per_dir => *posint* (default: 1)
Number of files to move to each diectory.
* files_then_dirs* => *array[pathname::exists]*
One or more existing file (or directory) names then the same number
of existing directories.
* reverse => *true* (default: 1)
Reverse processing (so first file will go to the last dir, second
file to second-last dir, and so on).
Special arguments:
* -dry_run => *bool*
Pass -dry_run=>1 to enable simulation mode.
Returns an enveloped result (an array).
First element ($status_code) is an integer containing HTTP-like status
code (200 means OK, 4xx caller error, 5xx function error). Second
element ($reason) is a string containing error message, or something
like "OK" if status is 200. Third element ($payload) is the actual
result, but usually not present when enveloped result is an error
response ($status_code is not 2xx). Fourth element (%result_meta) is
called result metadata and is optional, a hash that contains extra
information, much like how HTTP response headers provide additional
metadata.
Return value: (any)
HOMEPAGE
Please visit the project's homepage at
<https://metacpan.org/release/File-Util-DirList>.
SOURCE
Source repository is at
<https://github.com/perlancar/perl-File-Util-DirList>.
AUTHOR
perlancar <perlancar@cpan.org>
CONTRIBUTING
To contribute, you can send patches by email/via RT, or send pull
requests on GitHub.
Most of the time, you don't need to build the distribution yourself. You
can simply modify the code, then test via:
% prove -l
If you want to build the distribution (e.g. to try to install it locally
on your system), you can install Dist::Zilla,
Dist::Zilla::PluginBundle::Author::PERLANCAR,
Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two
other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps
required beyond that are considered a bug and can be reported to me.
COPYRIGHT AND LICENSE
This software is copyright (c) 2023 by perlancar <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.
BUGS
Please report any bugs or feature requests on the bugtracker website
<https://rt.cpan.org/Public/Dist/Display.html?Name=File-Util-DirList>
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.