Debian Codegraph @

upstream/debian-unstable/man3/Test2::EventFacet::Parent.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::Parent 3perl"
58 .TH Test2::EventFacet::Parent 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::Parent \- Facet for events contains other events
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 This facet is used when an event contains other events, such as a subtest.
68 .SH FIELDS
69 .IX Header "FIELDS"
70 .ie n .IP "$string = $parent\->{details}" 4
71 .el .IP "\f(CW$string\fR = \f(CW$parent\fR\->{details}" 4
72 .IX Item "$string = $parent->{details}"
73 .PD 0
74 .ie n .IP "$string = $parent\->\fBdetails()\fR" 4
75 .el .IP "\f(CW$string\fR = \f(CW$parent\fR\->\fBdetails()\fR" 4
76 .IX Item "$string = $parent->details()"
77 .PD
78 Human readable description of the event.
79 .ie n .IP "$hid = $parent\->{hid}" 4
80 .el .IP "\f(CW$hid\fR = \f(CW$parent\fR\->{hid}" 4
81 .IX Item "$hid = $parent->{hid}"
82 .PD 0
83 .ie n .IP "$hid = $parent\->\fBhid()\fR" 4
84 .el .IP "\f(CW$hid\fR = \f(CW$parent\fR\->\fBhid()\fR" 4
85 .IX Item "$hid = $parent->hid()"
86 .PD
87 Hub ID of the hub that is represented in the parent-child relationship.
88 .ie n .IP "$arrayref = $parent\->{children}" 4
89 .el .IP "\f(CW$arrayref\fR = \f(CW$parent\fR\->{children}" 4
90 .IX Item "$arrayref = $parent->{children}"
91 .PD 0
92 .ie n .IP "$arrayref = $parent\->\fBchildren()\fR" 4
93 .el .IP "\f(CW$arrayref\fR = \f(CW$parent\fR\->\fBchildren()\fR" 4
94 .IX Item "$arrayref = $parent->children()"
95 .PD
96 Arrayref containing the facet-data hashes of events nested under this one.
97 .Sp
98 \&\fITo get the actual events you need to get them from the parent event directly\fR
99 .ie n .IP "$bool = $parent\->{buffered}" 4
100 .el .IP "\f(CW$bool\fR = \f(CW$parent\fR\->{buffered}" 4
101 .IX Item "$bool = $parent->{buffered}"
102 .PD 0
103 .ie n .IP "$bool = $parent\->\fBbuffered()\fR" 4
104 .el .IP "\f(CW$bool\fR = \f(CW$parent\fR\->\fBbuffered()\fR" 4
105 .IX Item "$bool = $parent->buffered()"
106 .PD
107 True if the subtest is buffered (meaning the formatter has probably not seen
108 them yet).
109 .SH SOURCE
110 .IX Header "SOURCE"
111 The source code repository for Test2 can be found at
112 <https://github.com/Test\-More/test\-more/>.
113 .SH MAINTAINERS
114 .IX Header "MAINTAINERS"
115 .IP "Chad Granum <[email protected]>" 4
116 .IX Item "Chad Granum <[email protected]>"
117 .SH AUTHORS
118 .IX Header "AUTHORS"
119 .PD 0
120 .IP "Chad Granum <[email protected]>" 4
121 .IX Item "Chad Granum <[email protected]>"
122 .PD
123 .SH COPYRIGHT
124 .IX Header "COPYRIGHT"
125 Copyright 2020 Chad Granum <[email protected]>.
126 .PP
127 This program is free software; you can redistribute it and/or
128 modify it under the same terms as Perl itself.
129 .PP
130 See <https://dev.perl.org/licenses/>