Debian Codegraph @

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