NAME

Rclone::Util - Utility routines related to rclone

VERSION

This document describes version 0.002 of Rclone::Util (from Perl distribution Rclone-Util), released on 2021-05-15.

FUNCTIONS

list_rclone_remotes

Usage:

 list_rclone_remotes(%args) -> [status, msg, payload, meta]

List known rclone remotes from rclone configuration file.

This function is not exported.

Arguments ('*' denotes required arguments):

• rclone_config_dirs => array[dirname]

• rclone_config_filenames => array[filename]

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)

parse_rclone_config

Usage:

 parse_rclone_config(%args) -> [status, msg, payload, meta]

Read and parse rclone configuration file(s).

By default will search these paths for rclone.conf:

All found files will be read, parsed, and merged.

Returns the merged config hash.

This function is not exported by default, but exportable.

Arguments ('*' denotes required arguments):

• rclone_config_dirs => array[dirname]

• rclone_config_filenames => array[filename]

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)

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Rclone-Util.

SOURCE

Source repository is at https://github.com/perlancar/perl-Rclone-Util.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Rclone-Util

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.

SEE ALSO

https://rclone.org

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2021 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.

cpanm Rclone::Util

perl -MCPAN -e shell
install Rclone::Util