The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
File-Digest-0.010
River stage three • 5 direct dependents • 245 total dependents
++
/ File::Digest

NAME

File::Digest - Calculate digests of files

VERSION

This document describes version 0.010 of File::Digest (from Perl distribution File-Digest), released on 2019-09-12.

SYNOPSIS

 use File::Digest qw(digest_files);

 my $res = digest_files(
     files => ["file1", "file2"],
     algorithm => 'md5', # default md5, available also: crc32, sha1, sha256
 );

DESCRIPTION

This module provides some convenience when you want to use Digest against files.

FUNCTIONS

digest_file

Usage:

 digest_file(%args) -> [status, msg, payload, meta]

Calculate digest of file.

Return 400 status when algorithm is unknown/unsupported.

This function is not exported.

Arguments ('*' denotes required arguments):

  • algorithm => str (default: "md5")

  • digest_args => array[str]

  • file* => filename

    Filename ("-" means stdin).

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

digest_files

Usage:

 digest_files(%args) -> [status, msg, payload, meta]

Calculate digests of files.

Dies when algorithm is unsupported/unknown.

This function is not exported by default, but exportable.

Arguments ('*' denotes required arguments):

  • algorithm => str (default: "md5")

  • digest_args => array[str]

  • files* => array[filename]

    Array of filenames (filename "-" means stdin).

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

HOMEPAGE

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

SOURCE

Source repository is at https://github.com/perlancar/perl-File-Digest.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=File-Digest

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.

SEE ALSO

Digest

xsum from App::xsum is a CLI for File::Digest. It can also check digests stored in checksum files against the actual digests computed from the original files.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2019, 2017, 2016 by 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.