xref: /openbsd-src/gnu/usr.bin/perl/cpan/Test-Simple/lib/Test2/EventFacet/Control.pm (revision 5486feefcc8cb79b19e014ab332cc5dfd05b3b33)
15759b3d2Safresh1package Test2::EventFacet::Control;
25759b3d2Safresh1use strict;
35759b3d2Safresh1use warnings;
45759b3d2Safresh1
5*5486feefSafresh1our $VERSION = '1.302199';
65759b3d2Safresh1
75759b3d2Safresh1BEGIN { require Test2::EventFacet; our @ISA = qw(Test2::EventFacet) }
8de8cc8edSafresh1use Test2::Util::HashBase qw{ -global -terminate -halt -has_callback -encoding -phase };
95759b3d2Safresh1
105759b3d2Safresh11;
115759b3d2Safresh1
125759b3d2Safresh1__END__
135759b3d2Safresh1
145759b3d2Safresh1=pod
155759b3d2Safresh1
165759b3d2Safresh1=encoding UTF-8
175759b3d2Safresh1
185759b3d2Safresh1=head1 NAME
195759b3d2Safresh1
205759b3d2Safresh1Test2::EventFacet::Control - Facet for hub actions and behaviors.
215759b3d2Safresh1
225759b3d2Safresh1=head1 DESCRIPTION
235759b3d2Safresh1
245759b3d2Safresh1This facet is used when the event needs to give instructions to the Test2
255759b3d2Safresh1internals.
265759b3d2Safresh1
275759b3d2Safresh1=head1 FIELDS
285759b3d2Safresh1
295759b3d2Safresh1=over 4
305759b3d2Safresh1
315759b3d2Safresh1=item $string = $control->{details}
325759b3d2Safresh1
335759b3d2Safresh1=item $string = $control->details()
345759b3d2Safresh1
355759b3d2Safresh1Human readable explanation for the special behavior.
365759b3d2Safresh1
375759b3d2Safresh1=item $bool = $control->{global}
385759b3d2Safresh1
395759b3d2Safresh1=item $bool = $control->global()
405759b3d2Safresh1
415759b3d2Safresh1True if the event is global in nature and should be seen by all hubs.
425759b3d2Safresh1
435759b3d2Safresh1=item $exit = $control->{terminate}
445759b3d2Safresh1
455759b3d2Safresh1=item $exit = $control->terminate()
465759b3d2Safresh1
475759b3d2Safresh1Defined if the test should immediately exit, the value is the exit code and may
485759b3d2Safresh1be C<0>.
495759b3d2Safresh1
505759b3d2Safresh1=item $bool = $control->{halt}
515759b3d2Safresh1
525759b3d2Safresh1=item $bool = $control->halt()
535759b3d2Safresh1
545759b3d2Safresh1True if all testing should be halted immediately.
555759b3d2Safresh1
565759b3d2Safresh1=item $bool = $control->{has_callback}
575759b3d2Safresh1
585759b3d2Safresh1=item $bool = $control->has_callback()
595759b3d2Safresh1
605759b3d2Safresh1True if the C<callback($hub)> method on the event should be called.
615759b3d2Safresh1
625759b3d2Safresh1=item $encoding = $control->{encoding}
635759b3d2Safresh1
645759b3d2Safresh1=item $encoding = $control->encoding()
655759b3d2Safresh1
665759b3d2Safresh1This can be used to change the encoding from this event onward.
675759b3d2Safresh1
68de8cc8edSafresh1=item $phase = $control->{phase}
69de8cc8edSafresh1
70de8cc8edSafresh1=item $phase = $control->phase()
71de8cc8edSafresh1
72de8cc8edSafresh1Used to signal that a phase change has occurred. Currently only the perl END
73de8cc8edSafresh1phase is signaled.
74de8cc8edSafresh1
755759b3d2Safresh1=back
765759b3d2Safresh1
775759b3d2Safresh1=head1 SOURCE
785759b3d2Safresh1
795759b3d2Safresh1The source code repository for Test2 can be found at
80*5486feefSafresh1L<https://github.com/Test-More/test-more/>.
815759b3d2Safresh1
825759b3d2Safresh1=head1 MAINTAINERS
835759b3d2Safresh1
845759b3d2Safresh1=over 4
855759b3d2Safresh1
865759b3d2Safresh1=item Chad Granum E<lt>exodist@cpan.orgE<gt>
875759b3d2Safresh1
885759b3d2Safresh1=back
895759b3d2Safresh1
905759b3d2Safresh1=head1 AUTHORS
915759b3d2Safresh1
925759b3d2Safresh1=over 4
935759b3d2Safresh1
945759b3d2Safresh1=item Chad Granum E<lt>exodist@cpan.orgE<gt>
955759b3d2Safresh1
965759b3d2Safresh1=back
975759b3d2Safresh1
985759b3d2Safresh1=head1 COPYRIGHT
995759b3d2Safresh1
100256a93a4Safresh1Copyright 2020 Chad Granum E<lt>exodist@cpan.orgE<gt>.
1015759b3d2Safresh1
1025759b3d2Safresh1This program is free software; you can redistribute it and/or
1035759b3d2Safresh1modify it under the same terms as Perl itself.
1045759b3d2Safresh1
105*5486feefSafresh1See L<https://dev.perl.org/licenses/>
1065759b3d2Safresh1
1075759b3d2Safresh1=cut
108