Debian Codegraph @

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