Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Test2::EventFacet.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Test2::EventFacet 3pm"
61 .TH Test2::EventFacet 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Test2::EventFacet \- Base class for all event facets.
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 Base class for all event facets.
71 .SH METHODS
72 .IX Header "METHODS"
73 .ie n .IP "$key = $facet_class\->\fBfacet_key()\fR" 4
74 .el .IP "\f(CW$key\fR = \f(CW$facet_class\fR\->\fBfacet_key()\fR" 4
75 .IX Item "$key = $facet_class->facet_key()"
76 This will return the key for the facet in the facet data hash.
77 .ie n .IP "$bool = $facet_class\->\fBis_list()\fR" 4
78 .el .IP "\f(CW$bool\fR = \f(CW$facet_class\fR\->\fBis_list()\fR" 4
79 .IX Item "$bool = $facet_class->is_list()"
80 This will return true if the facet should be in a list instead of a single
81 item.
82 .ie n .IP "$clone = $facet\->\fBclone()\fR" 4
83 .el .IP "\f(CW$clone\fR = \f(CW$facet\fR\->\fBclone()\fR" 4
84 .IX Item "$clone = $facet->clone()"
85 .PD 0
86 .ie n .IP "$clone = $facet\->clone(%replace)" 4
87 .el .IP "\f(CW$clone\fR = \f(CW$facet\fR\->clone(%replace)" 4
88 .IX Item "$clone = $facet->clone(%replace)"
89 .PD
90 This will make a shallow clone of the facet. You may specify fields to override
91 as arguments.
92 .SH SOURCE
93 .IX Header "SOURCE"
94 The source code repository for Test2 can be found at
95 <https://github.com/Test\-More/test\-more/>.
96 .SH MAINTAINERS
97 .IX Header "MAINTAINERS"
98 .IP "Chad Granum <[email protected]>" 4
99 .IX Item "Chad Granum <[email protected]>"
100 .SH AUTHORS
101 .IX Header "AUTHORS"
102 .IP "Chad Granum <[email protected]>" 4
103 .IX Item "Chad Granum <[email protected]>"
104 .SH COPYRIGHT
105 .IX Header "COPYRIGHT"
106 Copyright Chad Granum <[email protected]>.
107 .PP
108 This program is free software; you can redistribute it and/or
109 modify it under the same terms as Perl itself.
110 .PP
111 See <https://dev.perl.org/licenses/>