Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Test2::Event::Exception.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::Event::Exception 3pm"
61 .TH Test2::Event::Exception 3pm 2026-03-09 "perl v5.42.1" "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::Event::Exception \- Exception event
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 An exception event will display to STDERR, and will prevent the overall test
71 file from passing.
72 .SH SYNOPSIS
73 .IX Header "SYNOPSIS"
74 .Vb 2
75 \& use Test2::API qw/context/;
76 \& use Test2::Event::Exception;
77 \&
78 \& my $ctx = context();
79 \& my $event = $ctx\->send_event(\*(AqException\*(Aq, error => \*(AqStuff is broken\*(Aq);
80 .Ve
81 .SH METHODS
82 .IX Header "METHODS"
83 Inherits from Test2::Event. Also defines:
84 .ie n .IP "$reason = $e\->error" 4
85 .el .IP "\f(CW$reason\fR = \f(CW$e\fR\->error" 4
86 .IX Item "$reason = $e->error"
87 The reason for the exception.
88 .SH CAVEATS
89 .IX Header "CAVEATS"
90 Be aware that all exceptions are stringified during construction.
91 .SH SOURCE
92 .IX Header "SOURCE"
93 The source code repository for Test2 can be found at
94 <https://github.com/Test\-More/test\-more/>.
95 .SH MAINTAINERS
96 .IX Header "MAINTAINERS"
97 .IP "Chad Granum <[email protected]>" 4
98 .IX Item "Chad Granum <[email protected]>"
99 .SH AUTHORS
100 .IX Header "AUTHORS"
101 .IP "Chad Granum <[email protected]>" 4
102 .IX Item "Chad Granum <[email protected]>"
103 .SH COPYRIGHT
104 .IX Header "COPYRIGHT"
105 Copyright Chad Granum <[email protected]>.
106 .PP
107 This program is free software; you can redistribute it and/or
108 modify it under the same terms as Perl itself.
109 .PP
110 See <https://dev.perl.org/licenses/>