/ 
Perinci-Examples-0.825
River stage three • 21 direct dependents • 573 total dependents
/ Perinci::Examples::ArgsAs

NAME

Perinci::Examples::ArgsAs - Demonstrate various values of `args_as` function metadata property

VERSION

This document describes version 0.825 of Perinci::Examples::ArgsAs (from Perl distribution Perinci-Examples), released on 2024-07-17.

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_code, $reason, $payload, \%result_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

    (No description)

  • $arg2* => int

    (No description)

  • $arg3 => float

    (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)

args_as_arrayref

Usage:

args_as_arrayref([$arg1, $arg2, $arg3]) -> [$status_code, $reason, $payload, \%result_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

    (No description)

  • $arg2* => int

    (No description)

  • $arg3 => float

    (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)

args_as_hash

Usage:

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

This is the default.

Examples:

  • Without the optional arg3:

    args_as_hash(arg1 => "abc", arg2 => 10); # -> [200, "OK", ["arg1", "abc", "arg2", 10], {}]

  • With the optional arg3:

    args_as_hash(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

    (No description)

  • arg2* => int

    (No description)

  • arg3 => float

    (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)

args_as_hashref

Usage:

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

    (No description)

  • arg2* => int

    (No description)

  • arg3 => float

    (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) 2024, 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.