View on
MetaCPAN
search.cpan.org is shutting down
For details read Perl NOC. After June 25th this page will redirect to MetaCPAN.org
perlancar > Perinci-Examples > Perinci::Examples::CmdLineResMeta

Download:
Perinci-Examples-0.80.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.80   Source  

NAME ^

Perinci::Examples::CmdLineResMeta - Functions in this package contains cmdline.* result metadata

VERSION ^

This document describes version 0.80 of Perinci::Examples::CmdLineResMeta (from Perl distribution Perinci-Examples), released on 2017-07-11.

FUNCTIONS ^

default_format

Usage:

 default_format() -> [status, msg, result, meta]

Set cmdline.default_format json.

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)

exit_code

Usage:

 exit_code() -> [status, msg, result, meta]

Returns cmdline exit code 7, even though status is 200.

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)

is_palindrome

Usage:

 is_palindrome(%args) -> [status, msg, result, meta]

Return true if string is palindrome.

This function is not exported.

Arguments ('*' denotes required 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)

result

Usage:

 result() -> [status, msg, result, meta]

Returns false, but cmdline.result the string "false".

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)

skip_format

Usage:

 skip_format() -> [status, msg, result, meta]

Set cmdline.skip_format => 1.

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)

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.

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.

AUTHOR ^

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2017, 2016, 2015, 2014, 2013, 2012, 2011 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.

syntax highlighting: