/ 
Filename-Compressed-0.050
River stage two • 8 direct dependents • 20 total dependents
/ Filename::Compressed

NAME

Filename::Compressed - Check whether filename indicates being compressed

VERSION

This document describes version 0.050 of Filename::Compressed (from Perl distribution Filename-Compressed), released on 2023-12-15.

SYNOPSIS

use Filename::Compressed qw(check_compressed_filename);
my $res = check_compressed_filename(filename => "foo.txt.gz");
if ($res) {
    printf "File is compressed with %s, uncompressed name: %s\n",
        $res->{compressor_name},
        $res->{uncompressed_filename};
} else {
    print "File is not compressed\n";
}

DESCRIPTION

FUNCTIONS

check_compressed_filename

Usage:

check_compressed_filename(%args) -> bool|hash

Check whether filename indicates being compressed.

Examples:

  • Example #1:

    check_compressed_filename(filename => "foo.bar"); # -> 0

  • Example #2:

    check_compressed_filename(filename => "baz.xz");

    Result:

    {
  compressor_name       => "XZ",
  compressor_suffix     => ".xz",
  uncompressed_filename => "baz",
}

  • Example #3:

    check_compressed_filename(filename => "qux.Bz2");

    Result:

    {
  compressor_name       => "Bzip2",
  compressor_suffix     => ".Bz2",
  uncompressed_filename => "qux",
}

This function is not exported by default, but exportable.

Arguments ('*' denotes required arguments):

  • filename* => str

    (No description)

  • ignore_case => bool (default: 1)

    Whether to match case-insensitively.

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.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Filename-Compressed.

SOURCE

Source repository is at https://github.com/perlancar/perl-Filename-Compressed.

SEE ALSO

Filename::Archive

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) 2023, 2015, 2014 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=Filename-Compressed

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.