NAME
Perinci::Examples::FilePartial - Examples for reading/writing files (demos partial argument/result)
VERSION
This document describes version 0.821 of Perinci::Examples::FilePartial (from Perl distribution Perinci-Examples), released on 2021-01-30.
DESCRIPTION
The functions in this package demoes partial content upload as well as partial result.
The functions are separated into this module because these functions read/write files on the filesystem and might potentially be dangerous if Perinci::Examples is exposed to the network by accident.
See also Perinci::Examples::FileStream which uses streaming instead of partial.
FUNCTIONS
append_file
Usage:
append_file(%args) -> [status, msg, payload, meta]This function doesn't actually accept partial content, because by nature it is already a partial/incremental operation.
This function is not exported.
Arguments ('*' denotes required arguments):
content* => buf
path* => 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)
read_file
Usage:
read_file(%args) -> [status, msg, payload, meta]This function is not exported.
Arguments ('*' denotes required arguments):
path* => 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: (buf)
write_file
Usage:
write_file(%args) -> [status, msg, payload, meta]This function is not exported.
Arguments ('*' denotes required arguments):
content* => buf
path* => 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.