NAME
Perinci::Examples::CmdLineSrc - Examples for using cmdline_src function property
VERSION
This document describes version 0.821 of Perinci::Examples::CmdLineSrc (from Perl distribution Perinci-Examples), released on 2021-01-30.
FUNCTIONS
binary
Usage:
binary(%args) -> [status, msg, payload, meta]Accept binary in stdin/file.
This function is like the one in Perinci::Examples but argument is accepted via stdin_or_files.
This function is not exported.
Arguments ('*' denotes required arguments):
data => buf (default: "\0\0\0")
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 (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (buf)
cmdline_src_file
Usage:
cmdline_src_file(%args) -> [status, msg, payload, meta]This function has args with cmdline_src=file.
This function is not exported.
Arguments ('*' denotes required arguments):
a1* => str
a2 => 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 (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
cmdline_src_invalid_arg_type
Usage:
cmdline_src_invalid_arg_type(%args) -> [status, msg, payload, meta]This function has non-str/non-array arg with cmdline_src.
This function is not exported.
Arguments ('*' denotes required arguments):
a1 => int
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 (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
cmdline_src_multi_stdin
Usage:
cmdline_src_multi_stdin(%args) -> [status, msg, payload, meta]This function has multiple args with cmdline_src stdin/stdin_or_files.
This function is not exported.
Arguments ('*' denotes required arguments):
a1 => str
a2 => str
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 (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
cmdline_src_multi_stdin_line
Usage:
cmdline_src_multi_stdin_line(%args) -> [status, msg, payload, meta]This function has several stdin_line arguments.
And one also has its is_password property set to true.
This function is not exported.
Arguments ('*' denotes required arguments):
a1* => str
a2* => str
a3* => str
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 (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
cmdline_src_stdin_array
Usage:
cmdline_src_stdin_array(%args) -> [status, msg, payload, meta]This function has arg with cmdline_src=stdin.
This function is not exported.
Arguments ('*' denotes required arguments):
a1 => 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 (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
cmdline_src_stdin_line
Usage:
cmdline_src_stdin_line(%args) -> [status, msg, payload, meta]This function has a single stdin_line argument.
This function is not exported.
Arguments ('*' denotes required arguments):
a1* => str
a2* => str
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 (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
cmdline_src_stdin_or_args_array
Usage:
cmdline_src_stdin_or_args_array(%args) -> [status, msg, payload, meta]This function has array arg with cmdline_src=stdin_or_args.
This function is not exported.
Arguments ('*' denotes required arguments):
a1 => array[str]
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 (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
cmdline_src_stdin_or_file_array
Usage:
cmdline_src_stdin_or_file_array(%args) -> [status, msg, payload, meta]This function has array arg with cmdline_src=stdin_or_file.
This function is not exported.
Arguments ('*' denotes required arguments):
a1 => 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 (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
cmdline_src_stdin_or_file_str
Usage:
cmdline_src_stdin_or_file_str(%args) -> [status, msg, payload, meta]This function has str arg with cmdline_src=stdin_or_file.
This function is not exported.
Arguments ('*' denotes required arguments):
a1 => str
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 (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
cmdline_src_stdin_or_files_array
Usage:
cmdline_src_stdin_or_files_array(%args) -> [status, msg, payload, meta]This function has array arg with cmdline_src=stdin_or_files.
This function is not exported.
Arguments ('*' denotes required arguments):
a1 => 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 (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
cmdline_src_stdin_or_files_str
Usage:
cmdline_src_stdin_or_files_str(%args) -> [status, msg, payload, meta]This function has str arg with cmdline_src=stdin_or_files.
This function is not exported.
Arguments ('*' denotes required arguments):
a1 => str
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 (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
cmdline_src_stdin_str
Usage:
cmdline_src_stdin_str(%args) -> [status, msg, payload, meta]This function has arg with cmdline_src=stdin.
This function is not exported.
Arguments ('*' denotes required arguments):
a1 => str
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 (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
cmdline_src_unknown
Usage:
cmdline_src_unknown(%args) -> [status, msg, payload, meta]This function has arg with unknown cmdline_src value.
This function is not exported.
Arguments ('*' denotes required arguments):
a1 => str
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 (payload) 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) 2021, 2020, 2019, 2018, 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.