Debian Codegraph @

upstream/debian-unstable/man3/Digest::base.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "Digest::base 3perl"
58 .TH Digest::base 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 Digest::base \- Digest base class
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 2
68 \& package Digest::Foo;
69 \& use base \*(AqDigest::base\*(Aq;
70 .Ve
71 .SH DESCRIPTION
72 .IX Header "DESCRIPTION"
73 The \f(CW\*(C`Digest::base\*(C'\fR class provide implementations of the methods
74 \&\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
75 \&\f(CW\*(C`hexdigest\*(C'\fR and \f(CW\*(C`b64digest\*(C'\fR in terms of \f(CW\*(C`digest\*(C'\fR.
76 .PP
77 Digest implementations might want to inherit from this class to get
78 this implementations of the alternative \fIadd\fR and \fIdigest\fR methods.
79 A minimal subclass needs to implement the following methods by itself:
80 .PP
81 .Vb 4
82 \& new
83 \& clone
84 \& add
85 \& digest
86 .Ve
87 .PP
88 The arguments and expected behaviour of these methods are described in
89 Digest.
90 .SH "SEE ALSO"
91 .IX Header "SEE ALSO"
92 Digest