NAME
Perinci::Examples::ArgsAs - Demonstrate various values of `args_as` function metadata property
VERSION
This document describes version 0.821 of Perinci::Examples::ArgsAs (from Perl distribution Perinci-Examples), released on 2021-01-30.
DESCRIPTION
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;
FUNCTIONS
args_as_array
Usage:
args_as_array($arg1, $arg2, $arg3) -> [status, msg, payload, meta]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 (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)
args_as_arrayref
Usage:
args_as_arrayref([$arg1, $arg2, $arg3]) -> [status, msg, payload, meta]Alternative to `array` to avoid copying.
Examples:
Without the optional arg3:
args_as_arrayref(["abc", 10]); # -> [200, "OK", [["abc", 10]], {}]With the optional arg3:
args_as_arrayref(["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 (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)
args_as_hash
Usage:
args_as_hash(%args) -> [status, msg, payload, meta]This is the default.
Examples:
Without the optional arg3:
args_as_hash(arg1 => "abc", arg2 => 10); # -> [200, "OK", ["arg2", 10, "arg1", "abc"], {}]With the optional arg3:
args_as_hash(arg1 => "def", arg2 => 20, arg3 => 0.5);Result:
[200, "OK", ["arg3", 0.5, "arg2", 20, "arg1", "def"], {}]
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 (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)
args_as_hashref
Usage:
args_as_hashref(\%args) -> [status, msg, payload, meta]Alternative to `hash` to avoid copying.
Examples:
Without the optional arg3:
args_as_hashref({ arg1 => "abc", arg2 => 10 }); # -> [200, "OK", [{ arg1 => "abc", arg2 => 10 }], {}]With the optional arg3:
args_as_hashref({ arg1 => "def", arg2 => 20, arg3 => 0.5 });Result:
[200, "OK", [{ arg1 => "def", arg2 => 20, arg3 => 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 (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/Perinci-Examples.
SOURCE
Source repository is at https://github.com/perlancar/perl-Perinci-Examples.
BUGS
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.
AUTHOR
perlancar <perlancar@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2021, 2020, 2019, 2018, 2017, 2016, 2015, 2014, 2013, 2012, 2011 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.