Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Test2::Tools::Event.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::Tools::Event 3pm"
61 .TH Test2::Tools::Event 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::Tools::Event \- Tools for generating test events.
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 This module provides tools for generating events quickly by bypassing the
71 context/hub. This is particularly useful when testing other Test2 packages.
72 .SH EXPORTS
73 .IX Header "EXPORTS"
74 .ie n .IP "$e = gen_event($TYPE)" 4
75 .el .IP "\f(CW$e\fR = gen_event($TYPE)" 4
76 .IX Item "$e = gen_event($TYPE)"
77 .PD 0
78 .ie n .IP "$e = gen_event($TYPE, %FIELDS)" 4
79 .el .IP "\f(CW$e\fR = gen_event($TYPE, \f(CW%FIELDS\fR)" 4
80 .IX Item "$e = gen_event($TYPE, %FIELDS)"
81 .ie n .IP "$e = gen_event \*(AqOk\*(Aq;" 4
82 .el .IP "\f(CW$e\fR = gen_event \*(AqOk\*(Aq;" 4
83 .IX Item "$e = gen_event 'Ok';"
84 .ie n .IP "$e = gen_event Ok => ( ... )" 4
85 .el .IP "\f(CW$e\fR = gen_event Ok => ( ... )" 4
86 .IX Item "$e = gen_event Ok => ( ... )"
87 .ie n .IP "$e = gen_event \*(Aq+Test2::Event::Ok\*(Aq => ( ... )" 4
88 .el .IP "\f(CW$e\fR = gen_event \*(Aq+Test2::Event::Ok\*(Aq => ( ... )" 4
89 .IX Item "$e = gen_event '+Test2::Event::Ok' => ( ... )"
90 .PD
91 This will produce an event of the specified type. \f(CW$TYPE\fR is assumed to be
92 shorthand for \f(CW\*(C`Test2::Event::$TYPE\*(C'\fR, you can prefix \f(CW$TYPE\fR with a \*(Aq+\*(Aq to
93 drop the assumption.
94 .Sp
95 An Test2::Util::Trace will be generated using \f(CWcaller(0)\fR and will be put in
96 the \*(Aqtrace\*(Aq field of your new event, unless you specified your own \*(Aqtrace\*(Aq
97 field.
98 .SH SOURCE
99 .IX Header "SOURCE"
100 The source code repository for Test2\-Suite can be found at
101 \&\fIhttps://github.com/Test\-More/test\-more/\fR.
102 .SH MAINTAINERS
103 .IX Header "MAINTAINERS"
104 .IP "Chad Granum <[email protected]>" 4
105 .IX Item "Chad Granum <[email protected]>"
106 .SH AUTHORS
107 .IX Header "AUTHORS"
108 .IP "Chad Granum <[email protected]>" 4
109 .IX Item "Chad Granum <[email protected]>"
110 .SH COPYRIGHT
111 .IX Header "COPYRIGHT"
112 Copyright Chad Granum <[email protected]>.
113 .PP
114 This program is free software; you can redistribute it and/or
115 modify it under the same terms as Perl itself.
116 .PP
117 See \fIhttp://dev.perl.org/licenses/\fR