package Perinci::Examples::Tiny;
our $DATE = '2016-10-26'; # DATE
our $VERSION = '0.75'; # VERSION
our %SPEC;
# this Rinci metadata is already normalized
$SPEC{noop} = {
v => 1.1,
summary => "Do nothing",
};
sub noop {
[200];
}
# this Rinci metadata is already normalized
$SPEC{hello_naked} = {
v => 1.1,
summary => "Hello world",
result_naked => 1,
};
sub hello_naked {
"Hello, world";
}
# this Rinci metadata is already normalized
$SPEC{odd_even} = {
v => 1.1,
summary => "Print 'odd' or 'even' depending on the number",
args => {
number => {
summary => 'Number to test',
schema => ['int' => {req=>1}, {}],
pos => 0,
req => 1,
},
},
result => {
schema => ['str', {}, {}],
},
};
sub odd_even {
my %args = @_;
[200, "OK", $args{number} % 2 == 0 ? "even" : "odd"];
}
1;
# ABSTRACT: Small examples
__END__
=pod
=encoding UTF-8
=head1 NAME
Perinci::Examples::Tiny - Small examples
=head1 VERSION
This document describes version 0.75 of Perinci::Examples::Tiny (from Perl distribution Perinci-Examples), released on 2016-10-26.
=head1 DESCRIPTION
This module only has a couple of examples and very lightweight. Used e.g. for
benchmarking startup overhead of L<Perinci::CmdLine::Inline>-generated scripts.
=head1 FUNCTIONS
=head2 hello_naked() -> any
Hello world.
This function is not exported.
No arguments.
Return value: (any)
=head2 noop() -> [status, msg, result, meta]
Do nothing.
This function is not exported.
No arguments.
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)
=head2 odd_even(%args) -> [status, msg, result, meta]
Print 'odd' or 'even' depending on the number.
This function is not exported.
Arguments ('*' denotes required arguments):
=over 4
=item * B<number>* => I<int>
Number to test.
=back
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: (str)
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/Perinci-Examples>.
=head1 SOURCE
Source repository is at L<https://github.com/perlancar/perl-Perinci-Examples>.
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website L<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.
=head1 AUTHOR
perlancar <perlancar@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2016 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.
=cut