Debian Codegraph @

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