NAME
App::QRCodeUtils - Utilities related to QR Code
VERSION
This document describes version 0.003 of App::QRCodeUtils (from Perl
distribution App-QRCodeUtils), released on 2024-04-17.
DESCRIPTION
This distributions provides the following command-line utilities:
* decode-qrcode
* gen-qrcode
FUNCTIONS
decode_qrcode
Usage:
decode_qrcode(%args) -> [$status_code, $reason, $payload, \%result_meta]
Decode QR Code.
This function is not exported.
Arguments ('*' denotes required arguments):
* filename* => *filename*
(No description)
Returns an enveloped result (an array).
First element ($status_code) is an integer containing HTTP-like status
code (200 means OK, 4xx caller error, 5xx function error). Second
element ($reason) is a string containing error message, or something
like "OK" if status is 200. Third element ($payload) is the actual
result, but usually not present when enveloped result is an error
response ($status_code is not 2xx). Fourth element (%result_meta) is
called result metadata and is optional, a hash that contains extra
information, much like how HTTP response headers provide additional
metadata.
Return value: (any)
gen_qrcode
Usage:
gen_qrcode(%args) -> [$status_code, $reason, $payload, \%result_meta]
Generate QR Code and by default show it (or save it to a file).
This function is not exported.
Arguments ('*' denotes required arguments):
* filename => *filename*
If unspecified, will save to a temporary filename and show it with
Desktop::Open.
* format => *str* (default: "png")
(No description)
* text* => *str*
(No description)
Returns an enveloped result (an array).
First element ($status_code) is an integer containing HTTP-like status
code (200 means OK, 4xx caller error, 5xx function error). Second
element ($reason) is a string containing error message, or something
like "OK" if status is 200. Third element ($payload) is the actual
result, but usually not present when enveloped result is an error
response ($status_code is not 2xx). Fourth element (%result_meta) is
called result metadata and is optional, a hash that contains extra
information, much like how HTTP response headers provide additional
metadata.
Return value: (any)
HOMEPAGE
Please visit the project's homepage at
<https://metacpan.org/release/App-QRCodeUtils>.
SOURCE
Source repository is at
<https://github.com/perlancar/perl-App-QRCodeUtils>.
SEE ALSO
App::GoogleAuthUtils
AUTHOR
perlancar <perlancar@cpan.org>
CONTRIBUTING
To contribute, you can send patches by email/via RT, or send pull
requests on GitHub.
Most of the time, you don't need to build the distribution yourself. You
can simply modify the code, then test via:
% prove -l
If you want to build the distribution (e.g. to try to install it locally
on your system), you can install Dist::Zilla,
Dist::Zilla::PluginBundle::Author::PERLANCAR,
Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two
other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps
required beyond that are considered a bug and can be reported to me.
COPYRIGHT AND LICENSE
This software is copyright (c) 2024, 2021, 2018 by perlancar
<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.
BUGS
Please report any bugs or feature requests on the bugtracker website
<https://rt.cpan.org/Public/Dist/Display.html?Name=App-QRCodeUtils>
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.