.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.el \{\
. de IX
..
.\}
.\" ========================================================================
.\"
.IX Title "Test2::Event::Ok 3"
.TH Test2::Event::Ok 3 "2019-04-27" "perl v5.10.1" "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::Event::Ok \- Ok event type
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Ok events are generated whenever you run a test that produces a result.
Examples are \f(CW\*(C`ok()\*(C'\fR, and \f(CW\*(C`is()\*(C'\fR.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& use Test2::API qw/context/;
\& use Test2::Event::Ok;
\&
\& my $ctx = context();
\& my $event = $ctx\->ok($bool, $name, \e@diag);
.Ve
.PP
or:
.PP
.Vb 6
\& my $ctx = context();
\& my $event = $ctx\->send_event(
\& \*(AqOk\*(Aq,
\& pass => $bool,
\& name => $name,
\& );
.Ve
.SH "ACCESSORS"
.IX Header "ACCESSORS"
.ie n .IP "$rb = $e\->pass" 4
.el .IP "\f(CW$rb\fR = \f(CW$e\fR\->pass" 4
.IX Item "$rb = $e->pass"
The original true/false value of whatever was passed into the event (but
reduced down to 1 or 0).
.ie n .IP "$name = $e\->name" 4
.el .IP "\f(CW$name\fR = \f(CW$e\fR\->name" 4
.IX Item "$name = $e->name"
Name of the test.
.ie n .IP "$b = $e\->effective_pass" 4
.el .IP "\f(CW$b\fR = \f(CW$e\fR\->effective_pass" 4
.IX Item "$b = $e->effective_pass"
This is the true/false value of the test after \s-1TODO\s0 and similar modifiers are
taken into account.
.SH "SOURCE"
.IX Header "SOURCE"
The source code repository for Test2 can be found at
\&\fIhttp://github.com/Test\-More/test\-more/\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 2019 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
Copyright 2K16 - 2K18 Indonesian Hacker Rulez