1package Test2::EventFacet::Control; 2use strict; 3use warnings; 4 5our $VERSION = '1.302162'; 6 7BEGIN { require Test2::EventFacet; our @ISA = qw(Test2::EventFacet) } 8use Test2::Util::HashBase qw{ -global -terminate -halt -has_callback -encoding }; 9 101; 11 12__END__ 13 14=pod 15 16=encoding UTF-8 17 18=head1 NAME 19 20Test2::EventFacet::Control - Facet for hub actions and behaviors. 21 22=head1 DESCRIPTION 23 24This facet is used when the event needs to give instructions to the Test2 25internals. 26 27=head1 FIELDS 28 29=over 4 30 31=item $string = $control->{details} 32 33=item $string = $control->details() 34 35Human readable explanation for the special behavior. 36 37=item $bool = $control->{global} 38 39=item $bool = $control->global() 40 41True if the event is global in nature and should be seen by all hubs. 42 43=item $exit = $control->{terminate} 44 45=item $exit = $control->terminate() 46 47Defined if the test should immediately exit, the value is the exit code and may 48be C<0>. 49 50=item $bool = $control->{halt} 51 52=item $bool = $control->halt() 53 54True if all testing should be halted immediately. 55 56=item $bool = $control->{has_callback} 57 58=item $bool = $control->has_callback() 59 60True if the C<callback($hub)> method on the event should be called. 61 62=item $encoding = $control->{encoding} 63 64=item $encoding = $control->encoding() 65 66This can be used to change the encoding from this event onward. 67 68=back 69 70=head1 SOURCE 71 72The source code repository for Test2 can be found at 73F<http://github.com/Test-More/test-more/>. 74 75=head1 MAINTAINERS 76 77=over 4 78 79=item Chad Granum E<lt>exodist@cpan.orgE<gt> 80 81=back 82 83=head1 AUTHORS 84 85=over 4 86 87=item Chad Granum E<lt>exodist@cpan.orgE<gt> 88 89=back 90 91=head1 COPYRIGHT 92 93Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>. 94 95This program is free software; you can redistribute it and/or 96modify it under the same terms as Perl itself. 97 98See F<http://dev.perl.org/licenses/> 99 100=cut 101