Debian Codegraph @

upstream/debian-unstable/man3/Test2::EventFacet::Info.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::Info 3perl"
58 .TH Test2::EventFacet::Info 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::Info \- Facet for information a developer might care about.
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 This facet represents messages intended for humans that will help them either
68 understand a result, or diagnose a failure.
69 .SH NOTES
70 .IX Header "NOTES"
71 This facet appears in a list instead of being a single item.
72 .SH FIELDS
73 .IX Header "FIELDS"
74 .ie n .IP "$string_or_structure = $info\->{details}" 4
75 .el .IP "\f(CW$string_or_structure\fR = \f(CW$info\fR\->{details}" 4
76 .IX Item "$string_or_structure = $info->{details}"
77 .PD 0
78 .ie n .IP "$string_or_structure = $info\->\fBdetails()\fR" 4
79 .el .IP "\f(CW$string_or_structure\fR = \f(CW$info\fR\->\fBdetails()\fR" 4
80 .IX Item "$string_or_structure = $info->details()"
81 .PD
82 Human readable string or data structure, this is the information to display.
83 Formatters are free to render the structures however they please. This may
84 contain a blessed object.
85 .Sp
86 If the \f(CW\*(C`table\*(C'\fR attribute (see below) is set then a renderer may choose to
87 display the table instead of the details.
88 .ie n .IP "$structure = $info\->{table}" 4
89 .el .IP "\f(CW$structure\fR = \f(CW$info\fR\->{table}" 4
90 .IX Item "$structure = $info->{table}"
91 .PD 0
92 .ie n .IP "$structure = $info\->\fBtable()\fR" 4
93 .el .IP "\f(CW$structure\fR = \f(CW$info\fR\->\fBtable()\fR" 4
94 .IX Item "$structure = $info->table()"
95 .PD
96 If the data the \f(CW\*(C`info\*(C'\fR facet needs to convey can be represented as a table
97 then the data may be placed in this attribute in a more raw form for better
98 display. The data must also be represented in the \f(CW\*(C`details\*(C'\fR attribute for
99 renderers which do not support rendering tables directly.
100 .Sp
101 The table structure:
102 .Sp
103 .Vb 2
104 \& my %table = {
105 \& header => [ \*(Aqcolumn 1 header\*(Aq, \*(Aqcolumn 2 header\*(Aq, ... ], # Optional
106 \&
107 \& rows => [
108 \& [\*(Aqrow 1 column 1\*(Aq, \*(Aqrow 1, column 2\*(Aq, ... ],
109 \& [\*(Aqrow 2 column 1\*(Aq, \*(Aqrow 2, column 2\*(Aq, ... ],
110 \& ...
111 \& ],
112 \&
113 \& # Allow the renderer to hide empty columns when true, Optional
114 \& collapse => $BOOL,
115 \&
116 \& # List by name or number columns that should never be collapsed
117 \& no_collapse => \e@LIST,
118 \& }
119 .Ve
120 .ie n .IP "$short_string = $info\->{tag}" 4
121 .el .IP "\f(CW$short_string\fR = \f(CW$info\fR\->{tag}" 4
122 .IX Item "$short_string = $info->{tag}"
123 .PD 0
124 .ie n .IP "$short_string = $info\->\fBtag()\fR" 4
125 .el .IP "\f(CW$short_string\fR = \f(CW$info\fR\->\fBtag()\fR" 4
126 .IX Item "$short_string = $info->tag()"
127 .PD
128 Short tag to categorize the info. This is usually 10 characters or less,
129 formatters may truncate longer tags.
130 .ie n .IP "$bool = $info\->{debug}" 4
131 .el .IP "\f(CW$bool\fR = \f(CW$info\fR\->{debug}" 4
132 .IX Item "$bool = $info->{debug}"
133 .PD 0
134 .ie n .IP "$bool = $info\->\fBdebug()\fR" 4
135 .el .IP "\f(CW$bool\fR = \f(CW$info\fR\->\fBdebug()\fR" 4
136 .IX Item "$bool = $info->debug()"
137 .PD
138 Set this to true if the message is critical, or explains a failure. This is
139 info that should be displayed by formatters even in less-verbose modes.
140 .Sp
141 When false the information is not considered critical and may not be rendered
142 in less-verbose modes.
143 .ie n .IP "$bool = $info\->{important}" 4
144 .el .IP "\f(CW$bool\fR = \f(CW$info\fR\->{important}" 4
145 .IX Item "$bool = $info->{important}"
146 .PD 0
147 .ie n .IP "$bool = $info\->important" 4
148 .el .IP "\f(CW$bool\fR = \f(CW$info\fR\->important" 4
149 .IX Item "$bool = $info->important"
150 .PD
151 This should be set for non debug messages that are still important enough to
152 show when a formatter is in quiet mode. A formatter should send these to STDOUT
153 not STDERR, but should show them even in non-verbose mode.
154 .SH SOURCE
155 .IX Header "SOURCE"
156 The source code repository for Test2 can be found at
157 <https://github.com/Test\-More/test\-more/>.
158 .SH MAINTAINERS
159 .IX Header "MAINTAINERS"
160 .IP "Chad Granum <[email protected]>" 4
161 .IX Item "Chad Granum <[email protected]>"
162 .SH AUTHORS
163 .IX Header "AUTHORS"
164 .PD 0
165 .IP "Chad Granum <[email protected]>" 4
166 .IX Item "Chad Granum <[email protected]>"
167 .PD
168 .SH COPYRIGHT
169 .IX Header "COPYRIGHT"
170 Copyright 2020 Chad Granum <[email protected]>.
171 .PP
172 This program is free software; you can redistribute it and/or
173 modify it under the same terms as Perl itself.
174 .PP
175 See <https://dev.perl.org/licenses/>