.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Test2::Tools::Event 3"
.TH Test2::Tools::Event 3 "2021-12-03" "perl v5.26.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Test2::Tools::Event \- Tools for generating test events.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides tools for generating events quickly by bypassing the
context/hub. This is particularly useful when testing other Test2 packages.
.SH "EXPORTS"
.IX Header "EXPORTS"
.ie n .IP "$e = gen_event($TYPE)" 4
.el .IP "\f(CW$e\fR = gen_event($TYPE)" 4
.IX Item "$e = gen_event($TYPE)"
.PD 0
.ie n .IP "$e = gen_event($TYPE, %FIELDS)" 4
.el .IP "\f(CW$e\fR = gen_event($TYPE, \f(CW%FIELDS\fR)" 4
.IX Item "$e = gen_event($TYPE, %FIELDS)"
.ie n .IP "$e = gen_event 'Ok';" 4
.el .IP "\f(CW$e\fR = gen_event 'Ok';" 4
.IX Item "$e = gen_event 'Ok';"
.ie n .IP "$e = gen_event Ok => ( ... )" 4
.el .IP "\f(CW$e\fR = gen_event Ok => ( ... )" 4
.IX Item "$e = gen_event Ok => ( ... )"
.ie n .IP "$e = gen_event '+Test2::Event::Ok' => ( ... )" 4
.el .IP "\f(CW$e\fR = gen_event '+Test2::Event::Ok' => ( ... )" 4
.IX Item "$e = gen_event '+Test2::Event::Ok' => ( ... )"
.PD
This will produce an event of the specified type. \f(CW$TYPE\fR is assumed to be
shorthand for \f(CW\*(C`Test2::Event::$TYPE\*(C'\fR, you can prefix \f(CW$TYPE\fR with a '+' to
drop the assumption.
.Sp
An Test2::Util::Trace will be generated using \f(CWcaller(0)\fR and will be put in
the 'trace' field of your new event, unless you specified your own 'trace'
field.
.SH "SOURCE"
.IX Header "SOURCE"
The source code repository for Test2\-Suite can be found at
\&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR.
.SH "MAINTAINERS"
.IX Header "MAINTAINERS"
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.SH "AUTHORS"
.IX Header "AUTHORS"
.PD 0
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.PD
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2018 Chad Granum <exodist@cpan.org>.
.PP
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.PP
See \fIhttp://dev.perl.org/licenses/\fR