Debian Codegraph @

upstream/debian-unstable/man3/Test2::EventFacet.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 "Test2::EventFacet 3perl"
58 .TH Test2::EventFacet 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 Test2::EventFacet \- Base class for all event facets.
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 Base class for all event facets.
68 .SH METHODS
69 .IX Header "METHODS"
70 .ie n .IP "$key = $facet_class\->\fBfacet_key()\fR" 4
71 .el .IP "\f(CW$key\fR = \f(CW$facet_class\fR\->\fBfacet_key()\fR" 4
72 .IX Item "$key = $facet_class->facet_key()"
73 This will return the key for the facet in the facet data hash.
74 .ie n .IP "$bool = $facet_class\->\fBis_list()\fR" 4
75 .el .IP "\f(CW$bool\fR = \f(CW$facet_class\fR\->\fBis_list()\fR" 4
76 .IX Item "$bool = $facet_class->is_list()"
77 This will return true if the facet should be in a list instead of a single
78 item.
79 .ie n .IP "$clone = $facet\->\fBclone()\fR" 4
80 .el .IP "\f(CW$clone\fR = \f(CW$facet\fR\->\fBclone()\fR" 4
81 .IX Item "$clone = $facet->clone()"
82 .PD 0
83 .ie n .IP "$clone = $facet\->clone(%replace)" 4
84 .el .IP "\f(CW$clone\fR = \f(CW$facet\fR\->clone(%replace)" 4
85 .IX Item "$clone = $facet->clone(%replace)"
86 .PD
87 This will make a shallow clone of the facet. You may specify fields to override
88 as arguments.
89 .SH SOURCE
90 .IX Header "SOURCE"
91 The source code repository for Test2 can be found at
92 <https://github.com/Test\-More/test\-more/>.
93 .SH MAINTAINERS
94 .IX Header "MAINTAINERS"
95 .IP "Chad Granum <[email protected]>" 4
96 .IX Item "Chad Granum <[email protected]>"
97 .SH AUTHORS
98 .IX Header "AUTHORS"
99 .PD 0
100 .IP "Chad Granum <[email protected]>" 4
101 .IX Item "Chad Granum <[email protected]>"
102 .PD
103 .SH COPYRIGHT
104 .IX Header "COPYRIGHT"
105 Copyright 2020 Chad Granum <[email protected]>.
106 .PP
107 This program is free software; you can redistribute it and/or
108 modify it under the same terms as Perl itself.
109 .PP
110 See <https://dev.perl.org/licenses/>