Debian Codegraph @

upstream/debian-unstable/man3/Test2::EventFacet::Error.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::Error 3perl"
58 .TH Test2::EventFacet::Error 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::Error \- Facet for errors that need to be shown.
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 This facet is used when an event needs to convey errors.
68 .SH NOTES
69 .IX Header "NOTES"
70 This facet has the hash key \f(CW\*(Aqerrors\*(Aq\fR, and is a list of facets instead of a
71 single item.
72 .SH FIELDS
73 .IX Header "FIELDS"
74 .ie n .IP "$string = $error\->{details}" 4
75 .el .IP "\f(CW$string\fR = \f(CW$error\fR\->{details}" 4
76 .IX Item "$string = $error->{details}"
77 .PD 0
78 .ie n .IP "$string = $error\->\fBdetails()\fR" 4
79 .el .IP "\f(CW$string\fR = \f(CW$error\fR\->\fBdetails()\fR" 4
80 .IX Item "$string = $error->details()"
81 .PD
82 Explanation of the error, or the error itself (such as an exception). In perl
83 exceptions may be blessed objects, so this field may contain a blessed object.
84 .ie n .IP "$short_string = $error\->{tag}" 4
85 .el .IP "\f(CW$short_string\fR = \f(CW$error\fR\->{tag}" 4
86 .IX Item "$short_string = $error->{tag}"
87 .PD 0
88 .ie n .IP "$short_string = $error\->\fBtag()\fR" 4
89 .el .IP "\f(CW$short_string\fR = \f(CW$error\fR\->\fBtag()\fR" 4
90 .IX Item "$short_string = $error->tag()"
91 .PD
92 Short tag to categorize the error. This is usually 10 characters or less,
93 formatters may truncate longer tags.
94 .ie n .IP "$bool = $error\->{fail}" 4
95 .el .IP "\f(CW$bool\fR = \f(CW$error\fR\->{fail}" 4
96 .IX Item "$bool = $error->{fail}"
97 .PD 0
98 .ie n .IP "$bool = $error\->\fBfail()\fR" 4
99 .el .IP "\f(CW$bool\fR = \f(CW$error\fR\->\fBfail()\fR" 4
100 .IX Item "$bool = $error->fail()"
101 .PD
102 Not all errors are fatal, some are displayed having already been handled. Set
103 this to true if you want the error to cause the test to fail. Without this the
104 error is simply a diagnostics message that has no effect on the overall
105 pass/fail result.
106 .SH SOURCE
107 .IX Header "SOURCE"
108 The source code repository for Test2 can be found at
109 <https://github.com/Test\-More/test\-more/>.
110 .SH MAINTAINERS
111 .IX Header "MAINTAINERS"
112 .IP "Chad Granum <[email protected]>" 4
113 .IX Item "Chad Granum <[email protected]>"
114 .SH AUTHORS
115 .IX Header "AUTHORS"
116 .PD 0
117 .IP "Chad Granum <[email protected]>" 4
118 .IX Item "Chad Granum <[email protected]>"
119 .PD
120 .SH COPYRIGHT
121 .IX Header "COPYRIGHT"
122 Copyright 2020 Chad Granum <[email protected]>.
123 .PP
124 This program is free software; you can redistribute it and/or
125 modify it under the same terms as Perl itself.
126 .PP
127 See <https://dev.perl.org/licenses/>