NAME
App::CrockfordBase32Utils - Utilities related to Crockford's Base 32 encoding
VERSION
This document describes version 0.001 of App::CrockfordBase32Utils (from Perl distribution App-CrockfordBase32Utils), released on 2026-01-19.
DESCRIPTION
This distribution contains the following CLIs:
Keywords: base32, base 32, crockford's base 32
FUNCTIONS
cfbase32_decode
Usage:
cfbase32_decode(%args) -> [$status_code, $reason, $payload, \%result_meta]Decode Crockford's Base32 encoding.
This function is not exported by default, but exportable.
Arguments ('*' denotes required arguments):
str => 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)
cfbase32_encode
Usage:
cfbase32_encode(%args) -> [$status_code, $reason, $payload, \%result_meta]Encode string to Crockford's Base32 encoding.
This function is not exported by default, but exportable.
Arguments ('*' denotes required arguments):
str => 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)
cfbase32_to_num
Usage:
cfbase32_to_num(%args) -> [$status_code, $reason, $payload, \%result_meta]Convert Crockford's Base 32 encoding to integer decimal number.
This function is not exported by default, but exportable.
Arguments ('*' denotes required arguments):
strs => array[int]
(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)
num_to_cfbase32
Usage:
num_to_cfbase32(%args) -> [$status_code, $reason, $payload, \%result_meta]Convert integer decimal number(s) to Crockford's Base 32 encoding.
This function is not exported by default, but exportable.
Arguments ('*' denotes required arguments):
nums => array[int]
(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-CrockfordBase32Utils.
SOURCE
Source repository is at https://github.com/perlancar/perl-App-CrockfordBase32Utils.
SEE ALSO
https://www.crockford.com/base32.html
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 -lIf 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) 2026 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-CrockfordBase32Utils
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.