Debian Codegraph @

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