Debian Codegraph @

upstream/mageia-cauldron/man3pm/Test2::EventFacet::Assert.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::Assert 3pm"
61 .TH Test2::EventFacet::Assert 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::Assert \- Facet representing an assertion.
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 The assertion facet is provided by any event representing an assertion that was
71 made.
72 .SH FIELDS
73 .IX Header "FIELDS"
74 .ie n .IP "$string = $assert\->{details}" 4
75 .el .IP "\f(CW$string\fR = \f(CW$assert\fR\->{details}" 4
76 .IX Item "$string = $assert->{details}"
77 .PD 0
78 .ie n .IP "$string = $assert\->\fBdetails()\fR" 4
79 .el .IP "\f(CW$string\fR = \f(CW$assert\fR\->\fBdetails()\fR" 4
80 .IX Item "$string = $assert->details()"
81 .PD
82 Human readable description of the assertion.
83 .ie n .IP "$bool = $assert\->{pass}" 4
84 .el .IP "\f(CW$bool\fR = \f(CW$assert\fR\->{pass}" 4
85 .IX Item "$bool = $assert->{pass}"
86 .PD 0
87 .ie n .IP "$bool = $assert\->\fBpass()\fR" 4
88 .el .IP "\f(CW$bool\fR = \f(CW$assert\fR\->\fBpass()\fR" 4
89 .IX Item "$bool = $assert->pass()"
90 .PD
91 True if the assertion passed.
92 .ie n .IP "$bool = $assert\->{no_debug}" 4
93 .el .IP "\f(CW$bool\fR = \f(CW$assert\fR\->{no_debug}" 4
94 .IX Item "$bool = $assert->{no_debug}"
95 .PD 0
96 .ie n .IP "$bool = $assert\->\fBno_debug()\fR" 4
97 .el .IP "\f(CW$bool\fR = \f(CW$assert\fR\->\fBno_debug()\fR" 4
98 .IX Item "$bool = $assert->no_debug()"
99 .PD
100 Set this to true if you have provided custom diagnostics and do not want the
101 defaults to be displayed.
102 .ie n .IP "$int = $assert\->{number}" 4
103 .el .IP "\f(CW$int\fR = \f(CW$assert\fR\->{number}" 4
104 .IX Item "$int = $assert->{number}"
105 .PD 0
106 .ie n .IP "$int = $assert\->\fBnumber()\fR" 4
107 .el .IP "\f(CW$int\fR = \f(CW$assert\fR\->\fBnumber()\fR" 4
108 .IX Item "$int = $assert->number()"
109 .PD
110 (Optional) assertion number. This may be omitted or ignored. This is usually
111 only useful when parsing/processing TAP.
112 .Sp
113 \&\fBNote\fR: This is not set by the Test2 system, assertion number is not known
114 until AFTER the assertion has been processed. This attribute is part of the
115 spec only for harnesses.
116 .SH SOURCE
117 .IX Header "SOURCE"
118 The source code repository for Test2 can be found at
119 <https://github.com/Test\-More/test\-more/>.
120 .SH MAINTAINERS
121 .IX Header "MAINTAINERS"
122 .IP "Chad Granum <[email protected]>" 4
123 .IX Item "Chad Granum <[email protected]>"
124 .SH AUTHORS
125 .IX Header "AUTHORS"
126 .IP "Chad Granum <[email protected]>" 4
127 .IX Item "Chad Granum <[email protected]>"
128 .SH COPYRIGHT
129 .IX Header "COPYRIGHT"
130 Copyright Chad Granum <[email protected]>.
131 .PP
132 This program is free software; you can redistribute it and/or
133 modify it under the same terms as Perl itself.
134 .PP
135 See <https://dev.perl.org/licenses/>