Debian Codegraph @

upstream/mageia-cauldron/man3pm/Test2::EventFacet::Info::Table.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::Info::Table 3pm"
61 .TH Test2::EventFacet::Info::Table 3pm 2025-06-24 "perl v5.42.0" "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::Info::Table \- Intermediary representation of a table.
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 Intermediary representation of a table for use in specialized
71 Test::API::Context methods which generate Test2::EventFacet::Info facets.
72 .SH SYNOPSIS
73 .IX Header "SYNOPSIS"
74 .Vb 2
75 \& use Test2::EventFacet::Info::Table;
76 \& use Test2::API qw/context/;
77 \&
78 \& sub my_tool {
79 \& my $ctx = context();
80 \&
81 \& ...
82 \&
83 \& $ctx\->fail(
84 \& $name,
85 \& "failure diag message",
86 \& Test2::EventFacet::Info::Table\->new(
87 \& # Required
88 \& rows => [[\*(Aqa\*(Aq, \*(Aqb\*(Aq], [\*(Aqc\*(Aq, \*(Aqd\*(Aq], ...],
89 \&
90 \& # Strongly Recommended
91 \& as_string => "... string to print when table cannot be rendered ...",
92 \&
93 \& # Optional
94 \& header => [\*(Aqcol1\*(Aq, \*(Aqcol2\*(Aq],
95 \& collapse => $bool,
96 \& no_collapse => [\*(Aqcol1\*(Aq, ...],
97 \& ),
98 \& );
99 \&
100 \& ...
101 \&
102 \& $ctx\->release;
103 \& }
104 \&
105 \& my_tool();
106 .Ve
107 .SH ATTRIBUTES
108 .IX Header "ATTRIBUTES"
109 .ie n .IP "$header_aref = $t\->\fBheader()\fR" 4
110 .el .IP "\f(CW$header_aref\fR = \f(CW$t\fR\->\fBheader()\fR" 4
111 .IX Item "$header_aref = $t->header()"
112 .PD 0
113 .ie n .IP "$rows_aref = $t\->\fBrows()\fR" 4
114 .el .IP "\f(CW$rows_aref\fR = \f(CW$t\fR\->\fBrows()\fR" 4
115 .IX Item "$rows_aref = $t->rows()"
116 .ie n .IP "$bool = $t\->\fBcollapse()\fR" 4
117 .el .IP "\f(CW$bool\fR = \f(CW$t\fR\->\fBcollapse()\fR" 4
118 .IX Item "$bool = $t->collapse()"
119 .ie n .IP "$aref = $t\->\fBno_collapse()\fR" 4
120 .el .IP "\f(CW$aref\fR = \f(CW$t\fR\->\fBno_collapse()\fR" 4
121 .IX Item "$aref = $t->no_collapse()"
122 .PD
123 The above are all directly tied to the table hashref structure described in
124 Test2::EventFacet::Info.
125 .ie n .IP "$str = $t\->\fBas_string()\fR" 4
126 .el .IP "\f(CW$str\fR = \f(CW$t\fR\->\fBas_string()\fR" 4
127 .IX Item "$str = $t->as_string()"
128 This returns the string form of the table if it was set, otherwise it returns
129 the string \f(CW"<TABLE NOT DISPLAYED>"\fR.
130 .ie n .IP "$href = $t\->\fBas_hash()\fR" 4
131 .el .IP "\f(CW$href\fR = \f(CW$t\fR\->\fBas_hash()\fR" 4
132 .IX Item "$href = $t->as_hash()"
133 This returns the data structure used for tables by Test2::EventFacet::Info.
134 .ie n .IP "%args = $t\->\fBinfo_args()\fR" 4
135 .el .IP "\f(CW%args\fR = \f(CW$t\fR\->\fBinfo_args()\fR" 4
136 .IX Item "%args = $t->info_args()"
137 This returns the arguments that should be used to construct the proper
138 Test2::EventFacet::Info structure.
139 .Sp
140 .Vb 1
141 \& return (table => $t\->as_hash(), details => $t\->as_string());
142 .Ve
143 .SH SOURCE
144 .IX Header "SOURCE"
145 The source code repository for Test2 can be found at
146 <https://github.com/Test\-More/test\-more/>.
147 .SH MAINTAINERS
148 .IX Header "MAINTAINERS"
149 .IP "Chad Granum <[email protected]>" 4
150 .IX Item "Chad Granum <[email protected]>"
151 .SH AUTHORS
152 .IX Header "AUTHORS"
153 .IP "Chad Granum <[email protected]>" 4
154 .IX Item "Chad Granum <[email protected]>"
155 .SH COPYRIGHT
156 .IX Header "COPYRIGHT"
157 Copyright Chad Granum <[email protected]>.
158 .PP
159 This program is free software; you can redistribute it and/or
160 modify it under the same terms as Perl itself.
161 .PP
162 See <https://dev.perl.org/licenses/>