Debian Codegraph @

upstream/debian-unstable/man3/Test2::EventFacet::Render.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::Render 3perl"
58 .TH Test2::EventFacet::Render 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::Render \- Facet that dictates how to render an event.
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 This facet is used to dictate how the event should be rendered by the standard
68 test2 rendering tools. If this facet is present then ONLY what is specified by
69 it will be rendered. It is assumed that anything important or note-worthy will
70 be present here, no other facets will be considered for rendering/display.
71 .PP
72 This facet is a list type, you can add as many items as needed.
73 .SH FIELDS
74 .IX Header "FIELDS"
75 .ie n .IP "$string = $render\->[#]\->{details}" 4
76 .el .IP "\f(CW$string\fR = \f(CW$render\fR\->[#]\->{details}" 4
77 .IX Item "$string = $render->[#]->{details}"
78 .PD 0
79 .ie n .IP "$string = $render\->[#]\->\fBdetails()\fR" 4
80 .el .IP "\f(CW$string\fR = \f(CW$render\fR\->[#]\->\fBdetails()\fR" 4
81 .IX Item "$string = $render->[#]->details()"
82 .PD
83 Human readable text for display.
84 .ie n .IP "$string = $render\->[#]\->{tag}" 4
85 .el .IP "\f(CW$string\fR = \f(CW$render\fR\->[#]\->{tag}" 4
86 .IX Item "$string = $render->[#]->{tag}"
87 .PD 0
88 .ie n .IP "$string = $render\->[#]\->\fBtag()\fR" 4
89 .el .IP "\f(CW$string\fR = \f(CW$render\fR\->[#]\->\fBtag()\fR" 4
90 .IX Item "$string = $render->[#]->tag()"
91 .PD
92 Tag that should prefix/identify the main text.
93 .ie n .IP "$string = $render\->[#]\->{facet}" 4
94 .el .IP "\f(CW$string\fR = \f(CW$render\fR\->[#]\->{facet}" 4
95 .IX Item "$string = $render->[#]->{facet}"
96 .PD 0
97 .ie n .IP "$string = $render\->[#]\->\fBfacet()\fR" 4
98 .el .IP "\f(CW$string\fR = \f(CW$render\fR\->[#]\->\fBfacet()\fR" 4
99 .IX Item "$string = $render->[#]->facet()"
100 .PD
101 Optional, if the display text was generated from another facet this should
102 state what facet it was.
103 .ie n .IP "$mode = $render\->[#]\->{mode}" 4
104 .el .IP "\f(CW$mode\fR = \f(CW$render\fR\->[#]\->{mode}" 4
105 .IX Item "$mode = $render->[#]->{mode}"
106 .PD 0
107 .ie n .IP "$mode = $render\->[#]\->\fBmode()\fR" 4
108 .el .IP "\f(CW$mode\fR = \f(CW$render\fR\->[#]\->\fBmode()\fR" 4
109 .IX Item "$mode = $render->[#]->mode()"
110 .RS 4
111 .IP calculated 4
112 .IX Item "calculated"
113 .PD
114 Calculated means the facet was generated from another facet. Calculated facets
115 may be cleared and regenerated whenever the event state changes.
116 .IP replace 4
117 .IX Item "replace"
118 Replace means the facet is intended to replace the normal rendering of the
119 event.
120 .RE
121 .RS 4
122 .RE
123 .SH SOURCE
124 .IX Header "SOURCE"
125 The source code repository for Test2 can be found at
126 <https://github.com/Test\-More/test\-more/>.
127 .SH MAINTAINERS
128 .IX Header "MAINTAINERS"
129 .IP "Chad Granum <[email protected]>" 4
130 .IX Item "Chad Granum <[email protected]>"
131 .SH AUTHORS
132 .IX Header "AUTHORS"
133 .PD 0
134 .IP "Chad Granum <[email protected]>" 4
135 .IX Item "Chad Granum <[email protected]>"
136 .PD
137 .SH COPYRIGHT
138 .IX Header "COPYRIGHT"
139 Copyright 2020 Chad Granum <[email protected]>.
140 .PP
141 This program is free software; you can redistribute it and/or
142 modify it under the same terms as Perl itself.
143 .PP
144 See <https://dev.perl.org/licenses/>