Perinci::Examples::Tiny - Small examples
This document describes version 0.824 of Perinci::Examples::Tiny (from Perl distribution Perinci-Examples), released on 2023-07-09.
This module only has a couple of examples and very lightweight. Used e.g. for benchmarking startup overhead of Perinci::CmdLine::Inline-generated scripts.
Usage:
foo1() -> [$status_code, $reason, $payload, \%result_meta]
Return the string 'foo1'.
This function is not exported.
No arguments.
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)
foo2() -> [$status_code, $reason, $payload, \%result_meta]
foo3() -> [$status_code, $reason, $payload, \%result_meta]
foo4() -> [$status_code, $reason, $payload, \%result_meta]
hello_naked() -> any
Hello world.
noop() -> [$status_code, $reason, $payload, \%result_meta]
Do nothing.
noop2(%args) -> [$status_code, $reason, $payload, \%result_meta]
Just like noop, but accepts several arguments.
Will return arguments passed to it.
This function is also marked as pure, meaning it will not cause any side effects. Pure functions are safe to call directly in a transaction (without going through the transaction manager) or during dry-run mode.
pure
This function is pure (produce no side effects).
Arguments ('*' denotes required arguments):
a => any
Argument.
b => any
c => any
d => any
e => any
odd_even(%args) -> [$status_code, $reason, $payload, \%result_meta]
Return 'odd' or 'even' depending on the number.
number* => int
Number to test.
Return value: (str)
sum(%args) -> [$status_code, $reason, $payload, \%result_meta]
Sum numbers in array.
This function can be used to test passing nonscalar (array) arguments.
array* => array[float]
Array.
round => bool (default: 0)
Whether to round result to integer.
Please visit the project's homepage at https://metacpan.org/release/Perinci-Examples.
Source repository is at https://github.com/perlancar/perl-Perinci-Examples.
perlancar <perlancar@cpan.org>
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.
This software is copyright (c) 2023, 2022, 2020, 2019, 2018, 2017, 2016, 2015, 2014, 2013, 2012, 2011 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.
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.
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.