NAME
Perinci::Examples::Stream - Examples for streaming input/output
VERSION
This document describes version 0.54 of Perinci::Examples::Stream (from Perl distribution Perinci-Examples), released on 2015-06-16.
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) 2015 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.
DESCRIPTION
This package contains functions that demonstrate streaming input/output.
FUNCTIONS
hash_stream(%args) -> [status, msg, result, meta]
This function produces a stream of hashes.
Arguments ('*' denotes required arguments):
num => 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 (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (hash)
nat(%args) -> [status, msg, result, meta]
This function produces a stream of natural numbers.
Arguments ('*' denotes required arguments):
num => 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 (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (int)
square_input(%args) -> [status, msg, result, meta]
This function squares its stream input.
Arguments ('*' denotes required arguments):
input* => float
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: (float)
wc(%args) -> [status, msg, result, meta]
Count the number of lines/words/characters of input, like the "wc" command.
Arguments ('*' denotes required arguments):
input* => 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 (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (str)
wc_keys(%args) -> [status, msg, result, meta]
Count the number of keys of each hash.
This is a simple demonstration of accepting a stream of hashes. In command-line application this will translate to JSON stream.
Arguments ('*' denotes required arguments):
input* => hash
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: (str)