Perinci::Examples::ArgsAs - Demonstrate various values of `args_as` function metadata property
This document describes version 0.78 of Perinci::Examples::ArgsAs (from Perl distribution Perinci-Examples), released on 2017-01-12.
The functions in this package can test:
argument passing;
whether module POD is rendered correctly;
whether examples (in module POD or CLI help) are rendered correctly;
Regular perl subs use this.
Examples:
Without the optional arg3:
args_as_array("abc", 10); # -> [200, "OK", ["abc", 10], {}]
With the optional arg3:
args_as_array("def", 20, 0.5); # -> [200, "OK", ["def", 20, 0.5], {}]
This function is not exported.
Arguments ('*' denotes required arguments):
$arg1* => str
$arg2* => int
$arg3 => float
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)
Alternative to `array` to avoid copying.
args_as_arrayref(["abc", 10]); # -> [200, "OK", [["abc", 10]], {}]
args_as_arrayref(["def", 20, 0.5]); # -> [200, "OK", [["def", 20, 0.5]], {}]
This is the default.
args_as_hash(arg1 => "abc", arg2 => 10); # -> [200, "OK", ["arg1", "abc", "arg2", 10], {}]
args_as_hash(arg1 => "def", arg2 => 20, arg3 => 0.5);
Result:
[200, "OK", ["arg3", 0.5, "arg2", 20, "arg1", "def"], {}]
arg1* => str
arg2* => int
arg3 => float
Alternative to `hash` to avoid copying.
args_as_hashref({ arg1 => "abc", arg2 => 10 }); # -> [200, "OK", [{ arg1 => "abc", arg2 => 10 }], {}]
args_as_hashref({ arg1 => "def", arg2 => 20, arg3 => 0.5 });
[200, "OK", [{ arg1 => "def", arg2 => 20, arg3 => 0.5 }], {}]
Please visit the project's homepage at https://metacpan.org/release/Perinci-Examples.
Source repository is at https://github.com/sharyanto/perl-Perinci-Examples.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Perinci-Examples
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.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2017 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 Perinci::Examples, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Perinci::Examples
CPAN shell
perl -MCPAN -e shell install Perinci::Examples
For more information on module installation, please visit the detailed CPAN module installation guide.