/usr/local/lp/sonarperl/man/man3/ Current File: //usr/local/lp/sonarperl/man/man3/Digest::base.3
.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Digest::base 3"
.TH Digest::base 3 2022-05-28 "perl v5.38.0" "Perl Programmers Reference Guide"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Digest::base \- Digest base class
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&  package Digest::Foo;
\&  use base \*(AqDigest::base\*(Aq;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \f(CW\*(C`Digest::base\*(C'\fR class provide implementations of the methods
\&\f(CW\*(C`addfile\*(C'\fR and \f(CW\*(C`add_bits\*(C'\fR in terms of \f(CW\*(C`add\*(C'\fR, and of the methods
\&\f(CW\*(C`hexdigest\*(C'\fR and \f(CW\*(C`b64digest\*(C'\fR in terms of \f(CW\*(C`digest\*(C'\fR.
.PP
Digest implementations might want to inherit from this class to get
this implementations of the alternative \fIadd\fR and \fIdigest\fR methods.
A minimal subclass needs to implement the following methods by itself:
.PP
.Vb 4
\&    new
\&    clone
\&    add
\&    digest
.Ve
.PP
The arguments and expected behaviour of these methods are described in
Digest.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Digest