NAME
Perinci::Examples::SahSchemas - Example for using various schemas
VERSION
This document describes version 0.003 of Perinci::Examples::SahSchemas (from Perl distribution Perinci-Examples-SahSchemas), released on 2020-03-14.
FUNCTIONS
schema_bandwidth
Usage:
schema_bandwidth(%args) -> [status, msg, payload, meta]This function is not exported.
Arguments ('*' denotes required arguments):
mod* => bandwidth
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)
schema_date
Usage:
schema_date(%args) -> [status, msg, payload, meta]This function is not exported.
Arguments ('*' denotes required arguments):
datetime => date
epoch => date
time_moment => date
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)
schema_dirname
Usage:
schema_dirname(%args) -> [status, msg, payload, meta]This function is not exported.
Arguments ('*' denotes required arguments):
mod* => dirname
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)
schema_filename
Usage:
schema_filename(%args) -> [status, msg, payload, meta]This function is not exported.
Arguments ('*' denotes required arguments):
mod* => filename
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)
schema_filesize
Usage:
schema_filesize(%args) -> [status, msg, payload, meta]This function is not exported.
Arguments ('*' denotes required arguments):
mod* => filesize
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)
schema_pathname
Usage:
schema_pathname(%args) -> [status, msg, payload, meta]This function is not exported.
Arguments ('*' denotes required arguments):
mod* => pathname
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)
schema_perl_distname
Usage:
schema_perl_distname(%args) -> [status, msg, payload, meta]This function is not exported.
Arguments ('*' denotes required arguments):
mod* => perl::distname
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)
schema_perl_modname
Usage:
schema_perl_modname(%args) -> [status, msg, payload, meta]This function is not exported.
Arguments ('*' denotes required arguments):
mod* => perl::modname
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-SahSchemas.
SOURCE
Source repository is at https://github.com/perlancar/perl-Perinci-Examples-SahSchemas.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Perinci-Examples-SahSchemas
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) 2020, 2018 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.