view release on metacpan or  search on metacpan

lib/Acrux/Digest.pm  view on Meta::CPAN

package Acrux::Digest;
use strict;
use utf8;

=encoding utf-8

=head1 NAME

Acrux::Digest - Acrux Digest base class

=head1 SYNOPSIS

    use parent qw/Acrux::Digest/;

=head1 DESCRIPTION

Acrux Digest base class

=head2 new

    my $provider = Acrux::Digest::Provider->new();

Returns Digest Provider instance

=head1 ATTRIBUTES

This class implements the following attributes

=head2 data

    my $data = $provider->data;
    $provider = $provider->data({foo => 'bar'});

Data structure to be processed

=head1 METHODS

This class implements the following methods

=head2 add

    $provider->add("data", "and another data", ...);

Add data to digest calculate.
All specified data of array will be concatenated to one pool of data

=head2 addfile

    $provider->addfile("/path/of/file");

Add file content to data pool

    $provider->addfile(*STDIN);

Add STDIN content to data pool

=head2 digest

    my $digest = $provider->digest;

Returns result digest (as is)

=head2 hexdigest