| Current Path : /proc/2/cwd/usr/share/man/man3/ |
| Current File : //proc/2/cwd/usr/share/man/man3/Test2::Event::V2.3pm |
.\" 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::V2 3"
.TH Test2::Event::V2 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::V2 \- Second generation event.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is the event type that should be used instead of Test2::Event or its
legacy subclasses.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.SS "\s-1USING\s0 A \s-1CONTEXT\s0"
.IX Subsection "USING A CONTEXT"
.Vb 1
\& use Test2::API qw/context/;
\&
\& sub my_tool {
\& my $ctx = context();
\&
\& my $event = $ctx\->send_ev2(info => [{tag => \*(AqNOTE\*(Aq, details => "This is a note"}]);
\&
\& $ctx\->release;
\&
\& return $event;
\& }
.Ve
.SS "\s-1USING\s0 \s-1THE\s0 \s-1CONSTRUCTOR\s0"
.IX Subsection "USING THE CONSTRUCTOR"
.Vb 1
\& use Test2::Event::V2;
\&
\& my $e = Test2::Event::V2\->new(
\& trace => {frame => [$PKG, $FILE, $LINE, $SUBNAME]},
\& info => [{tag => \*(AqNOTE\*(Aq, details => "This is a note"}],
\& );
.Ve
.SH "METHODS"
.IX Header "METHODS"
This class inherits from Test2::Event.
.ie n .IP "$fd = $e\->\fIfacet_data()\fR" 4
.el .IP "\f(CW$fd\fR = \f(CW$e\fR\->\fIfacet_data()\fR" 4
.IX Item "$fd = $e->facet_data()"
This will return a hashref of facet data. Each facet hash will be a shallow
copy of the original.
.ie n .IP "$about = $e\->\fIabout()\fR" 4
.el .IP "\f(CW$about\fR = \f(CW$e\fR\->\fIabout()\fR" 4
.IX Item "$about = $e->about()"
This will return the 'about' facet hashref.
.Sp
\&\fB\s-1NOTE:\s0\fR This will return the internal hashref, not a copy.
.ie n .IP "$trace = $e\->\fItrace()\fR" 4
.el .IP "\f(CW$trace\fR = \f(CW$e\fR\->\fItrace()\fR" 4
.IX Item "$trace = $e->trace()"
This will return the 'trace' facet, normally blessed (but this is not enforced
when the trace is set using \f(CW\*(C`set_trace()\*(C'\fR.
.Sp
\&\fB\s-1NOTE:\s0\fR This will return the internal trace, not a copy.
.SS "\s-1MUTATION\s0"
.IX Subsection "MUTATION"
.ie n .IP "$e\->add_amnesty({...})" 4
.el .IP "\f(CW$e\fR\->add_amnesty({...})" 4
.IX Item "$e->add_amnesty({...})"
Inherited from Test2::Event. This can be used to add 'amnesty' facets to an
existing event. Each new item is added to the \fB\s-1END\s0\fR of the list.
.Sp
\&\fB\s-1NOTE:\s0\fR Items \fB\s-1ARE\s0\fR blessed when added.
.ie n .IP "$e\->add_hub({...})" 4
.el .IP "\f(CW$e\fR\->add_hub({...})" 4
.IX Item "$e->add_hub({...})"
Inherited from Test2::Event. This is used by hubs to stamp events as they
pass through. New items are added to the \fB\s-1START\s0\fR of the list.
.Sp
\&\fB\s-1NOTE:\s0\fR Items \fB\s-1ARE\s0 \s-1NOT\s0\fR blessed when added.
.ie n .IP "$e\->set_uuid($UUID)" 4
.el .IP "\f(CW$e\fR\->set_uuid($UUID)" 4
.IX Item "$e->set_uuid($UUID)"
Inherited from Test2::Event, overridden to also vivify/mutate the 'about'
facet.
.ie n .IP "$e\->set_trace($trace)" 4
.el .IP "\f(CW$e\fR\->set_trace($trace)" 4
.IX Item "$e->set_trace($trace)"
Inherited from Test2::Event which allows you to change the trace.
.Sp
\&\fBNote:\fR This method does not bless/clone the trace for you. Many things will
expect the trace to be blessed, so you should probably do that.
.SS "\s-1LEGACY\s0 \s-1SUPPORT\s0 \s-1METHODS\s0"
.IX Subsection "LEGACY SUPPORT METHODS"
These are all imported from Test2::Util::Facets2Legacy, see that module or
Test2::Event for documentation on what they do.
.IP "causes_fail" 4
.IX Item "causes_fail"
.PD 0
.IP "diagnostics" 4
.IX Item "diagnostics"
.IP "global" 4
.IX Item "global"
.IP "increments_count" 4
.IX Item "increments_count"
.IP "no_display" 4
.IX Item "no_display"
.IP "sets_plan" 4
.IX Item "sets_plan"
.IP "subtest_id" 4
.IX Item "subtest_id"
.IP "summary" 4
.IX Item "summary"
.IP "terminate" 4
.IX Item "terminate"
.PD
.SH "THIRD PARTY META-DATA"
.IX Header "THIRD PARTY META-DATA"
This object consumes Test2::Util::ExternalMeta which provides a consistent
way for you to attach meta-data to instances of this class. This is useful for
tools, plugins, and other extensions.
.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
;?>)