Perinci::Examples::SubMeta - Test argument submetadata
This document describes version 0.69 of Perinci::Examples::SubMeta (from Perl distribution Perinci-Examples), released on 2016-02-04.
Argument submetadata is introduced in Rinci 1.1.55, mainly to support (complex) form. With this, you can submit a complex form (one that has subforms) to a function. The function will receive the form submission as a nested data structure.
To add an argument submetadata, you specify a hash argument with a meta property, or an array argument with element_meta property. The value of the property is another Rinci function metadata.
meta
element_meta
Register donor(s).
This example function registers one or more blood donors. For each donor, you need to specify at least the name, gender, age, and blood type.
In the command-line, you can specify them as follow:
% register-donors --date 2014-10-11 \ --donor-name Ujang --donor-age 31 --donor-male --donor-t A \ --donor-name Ita --donor-age 25 --donor-F --donor-t O \ --donor-note Tentative \ --donor-name Eep --donor-age 37 --donor-male --donor-t B
Actually, this function just returns its arguments. This function demonstrates argument element submetadata.
This function is not exportable.
Arguments ('*' denotes required arguments):
date* => date
Planned donation date.
donor* => array
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)
Register a student to a class.
This example function registers a student to a class. You specify the student's name, gender, and age, as well as the desired class to register to. You can only register one student at a time.
Actually, this function just returns its arguments.
class => str
Desired class.
note* => str
student => hash
Please visit the project's homepage at https://metacpan.org/release/Perinci-Examples.
Source repository is at https://github.com/perlancar/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) 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.
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.