view release on metacpan or  search on metacpan

README  view on Meta::CPAN

NAME
    App::FilenameUtils - CLIs for Filename::*

VERSION
    This document describes version 0.003 of App::FilenameUtils (from Perl
    distribution App-FilenameUtils), released on 2025-08-23.

SYNOPSIS
DESCRIPTION
    This distribution includes several utilities related to Filename::*
    modules:

    1. check-archive-filename
    2. check-audio-filename
    3. check-backup-filename
    4. check-compressed-filename
    5. check-ebook-filename
    6. check-executable-filename
    7. check-image-filename
    8. check-media-filename
    9. check-video-filename
    10. parse-media-filename

FUNCTIONS
  check_archive_filename
    Usage:

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

    Check whether filename indicates being an archive file.

    This function is not exported.

    Arguments ('*' denotes required arguments):

    *   detail => *bool*

        (No description)

    *   filename* => *str*

        (No description)

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

        Whether to match case-insensitively.

    *   quiet => *bool*

        (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: (bool|hash)

    Return false if no archive suffixes detected. Otherwise return a hash of
    information, which contains these keys: "archive_name",
    "archive_suffix", "compressor_info", "filename_without_suffix".

  check_audio_filename
    Usage:

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

    Check whether filename indicates being an audio file.

    This function is not exported.

    Arguments ('*' denotes required arguments):

    *   detail => *bool*

        (No description)

    *   filename* => *filename*

        (No description)

    *   quiet => *bool*

        (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: (bool|hash)

    Return false if no archive suffixes detected. Otherwise return a hash of
    information.

  check_backup_filename
    Usage:

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

    Check whether filename indicates being a backup file.

    This function is not exported.

    Arguments ('*' denotes required arguments):

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

        Whether to match case-insensitively.

    *   detail => *bool*

        (No description)

    *   filename* => *str*

        (No description)

    *   quiet => *bool*

        (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: (bool|hash)

    Return false if not detected as backup name. Otherwise return a hash,
    which may contain these keys: "original_filename". In the future there
    will be extra information returned, e.g. editor name (if filename
    indicates backup from certain backup program), date (if filename
    contains date information), and so on.

  check_compressed_filename
    Usage:

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

    Check whether filename indicates being compressed.

    This function is not exported.

    Arguments ('*' denotes required arguments):

    *   detail => *bool*

        (No description)

    *   filename* => *str*

        (No description)

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

        Whether to match case-insensitively.

    *   quiet => *bool*

        (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: (bool|hash)

    Return false if no compressor suffixes detected. Otherwise return a hash
    of information, which contains these keys: "compressor_name",
    "compressor_suffix", "uncompressed_filename".

  check_ebook_filename
    Usage:

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

    Check whether filename indicates being an e-book.

    This function is not exported.

    Arguments ('*' denotes required arguments):

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