/ 
Perinci-Examples-0.824
River stage three • 21 direct dependents • 573 total dependents
/ Perinci::Examples::SubMeta

NAME

Perinci::Examples::SubMeta - Test argument submetadata

VERSION

This document describes version 0.824 of Perinci::Examples::SubMeta (from Perl distribution Perinci-Examples), released on 2023-07-09.

DESCRIPTION

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.

FUNCTIONS

register_donors

Usage:

register_donors(%args) -> [$status_code, $reason, $payload, \%result_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 exported.

Arguments ('*' denotes required arguments):

  • date* => date

    Planned donation date.

  • donor* => array

    (No description)

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)

register_student

Usage:

register_student(%args) -> [$status_code, $reason, $payload, \%result_meta]

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.

This function is not exported.

Arguments ('*' denotes required arguments):

  • class => str

    Desired class.

  • note* => str

    (No description)

  • student => hash

    (No description)

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)

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.

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

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.

COPYRIGHT AND LICENSE

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.

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.