NAME
    App::CrockfordBase32Utils - Utilities related to Crockford's Base 32
    encoding

VERSION
    This document describes version 0.003 of App::CrockfordBase32Utils (from
    Perl distribution App-CrockfordBase32Utils), released on 2026-01-20.

DESCRIPTION
    This distribution contains the following CLIs:

    *   cfbase32-decode

    *   cfbase32-encode

    *   cfbase32-rand

    *   cfbase32-to-num

    *   num-to-cfbase32

    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-encoded string.

    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_rand
    Usage:

     cfbase32_rand(%args) -> [$status_code, $reason, $payload, \%result_meta]

    Generate one or more Crockford Base 32 numbers.

    Examples:

    *   Generate 35 random numbers from 12 digits each, first digit(s) can
        be 0:

         cfbase32_rand(len => 12, num => 35);

        Result:

         [
           200,
           "OK",
           [
             "BSNSRF2F9Y7C",
             "0KRQJKYRY3GC",
             "6AP4BK914YFT",
             "D99V5RGJ35RJ",
             "N4BYJ56754H4",
             "QNC1CT4XFXXD",
             "QTS5S2B6VV9G",
             "Z8SF1198XZED",
             "GGZBSW7X1A10",
             "7F47C6Y05B37",
             "5GVPQ07YRWHE",
             "54N37HV0EZT9",
             "8ZNYJ7VYKCQD",
             "5N93ZGT4VSCQ",
             "AYC79RT3PJVS",
             "E50QDKJBNWF0",
             "Q6GD5WT7PJ9B",
             "ZETH5SN1DDV3",
             "RD4K3TDGZQF6",
             "4B65QF8SNCGT",
             "RW86Z1WDG3WC",
             "Q8QHFN9GC6WH",
             "5V4RW9RG07FW",
             "N84VMR010KZT",
             "83R3EC2Y9SA5",
             "K1TDKKYD5T31",
             "JZYTSCP5MB0A",
             "AKYTNZ2JTZCB",
             "RZ8DSJP1JEKH",
             "3C65NKR77B82",
             "KS5C0YK587R0",
             "T60WN6Z6MGWS",
             "01W64RP5T642",
             "7FPZ2MFQ895H",
             "2JYVCZ3A5KZV",
           ],
           {},
         ]

    *   Generate 35 random numbers from 12 digits each, first digit(s)
        CANNOT be 0:

         cfbase32_rand(len => 12, num => 35, zero_prefix => 0);

        Result:

         [
           200,
           "OK",
           [
             "PMQ1620K7R90",
             "KQ3JSZDZ3T21",
             "FG1M8HH4PRRK",
             "YB77RJN7RK1A",
             "NTEKN45NDRQQ",
             "FZ1BKNTS36RF",
             "4DVC5NR22FJM",
             "1B6PKA8PFVGY",
             "KVHBM642RRMA",
             "XD2C0P1C6DJY",
             "RWRR4HH3535S",
             "7YFYR1XGMPGP",
             "VBV2P0XG48TC",
             "PZKSE2PRVQVV",
             "2G97XHA4ZW6Y",
             "HRJCZVEERZ0E",
             "MN82PPHMA7EG",
             "WTW776EX7VCH",
             "QG8AR7MCB8P6",
             "XTYM2HHYF387",
             "Y1F2WJSENH7H",
             "XK43A6NFW4HB",
             "BE9XYDT7X0ZC",
             "VK0Q9NJH9X9Y",
             "5K6XEWB37R3T",
             "2T9ZKN0K1CVF",
             "4CYBM1SX1427",
             "49HNW725F500",
             "C8VE23QWV4HR",
             "FSZ8VBF8VVMF",
             "KDJNZ47GWWY1",
             "5CN3F0Z8VR86",
             "7MBA0J51GSNF",
             "SFWJ74DFNKT9",
             "85J79X5V1789",
           ],
           {},
         ]

    *   Generate a formatted random code:

         cfbase32_rand(fill_char_template => "###-###-###", len => 9); # -> [200, "OK", ["GS1-F5B-5PC"], {}]

    This function is not exported by default, but exportable.

    Arguments ('*' denotes required arguments):

    *   fill_char_template => *str*

        Provide a template for formatting number, e.g. "###-###-###".

        See String::FillCharTemplate for more details.

    *   len => *int*

        Specify how many number of digits to generate for a number.

        Note that the first digit can still be 0 unless zero_prefix is set
        to false.

    *   max_base32 => *str*

        (No description)

    *   max_int => *int*

        (No description)

    *   max_len => *int*

        Specify how many maximum number of digits to generate.

        Note that the first digit can still be 0 unless zero_prefix is set
        to false.

    *   min_base32 => *str*

        (No description)

    *   min_int => *int*

        (No description)

    *   min_len => *int*

        Specify how many minimum number of digits to generate.

        Note that the first digit can still be 0 unless zero_prefix is set
        to false.

    *   num => *uint* (default: 1)

        Specify how many numbers to generate.

    *   prev_file => *filename*

        Load list of previous numbers from the specified file.

        The file will be read per-line. Empty lines and lines starting with
        "#" will be skipped. Non-digits will be removed first. Lowercase
        will be converted to uppercase. I L will be normalized to 1, O will
        be normalized to 0.

    *   unique => *bool*

        Whether to avoid generating previously generated numbers.

    *   zero_prefix => *bool* (default: 1)

        When generating random number of certain length range, whether the
        first digit is allowed to be zero.

    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[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)

  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 -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) 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-CrockfordBase32Ut
    ils>

    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.

