Test2::EventFacet::Control(3p) Perl Programmers Reference Guide

Test2::EventFacet::Control(3p) Perl Programmers Reference Guide #

Test2::EventFacet::Control(3p) Perl Programmers Reference Guide

NNAAMMEE #

 Test2::EventFacet::Control - Facet for hub actions and behaviors.

DDEESSCCRRIIPPTTIIOONN #

 This facet is used when the event needs to give instructions to the Test2
 internals.

FFIIEELLDDSS #

 $string = $control->{details}
 $string = $control->ddeettaaiillss(())
     Human readable explanation for the special behavior.

 $bool = $control->{global}
 $bool = $control->gglloobbaall(())
     True if the event is global in nature and should be seen by all hubs.

 $exit = $control->{terminate}
 $exit = $control->tteerrmmiinnaattee(())
     Defined if the test should immediately exit, the value is the exit
     code and may be 0.

 $bool = $control->{halt}
 $bool = $control->hhaalltt(())
     True if all testing should be halted immediately.

 $bool = $control->{has_callback}
 $bool = $control->hhaass__ccaallllbbaacckk(())
     True if the "callback($hub)" method on the event should be called.

 $encoding = $control->{encoding}
 $encoding = $control->eennccooddiinngg(())
     This can be used to change the encoding from this event onward.

 $phase = $control->{phase}
 $phase = $control->pphhaassee(())
     Used to signal that a phase change has occurred. Currently only the
     perl END phase is signaled.

SSOOUURRCCEE #

 The source code repository for Test2 can be found at
 _h_t_t_p_:_/_/_g_i_t_h_u_b_._c_o_m_/_T_e_s_t_-_M_o_r_e_/_t_e_s_t_-_m_o_r_e_/.

MMAAIINNTTAAIINNEERRSS #

 Chad Granum <exodist@cpan.org>

AAUUTTHHOORRSS #

 Chad Granum <exodist@cpan.org>

CCOOPPYYRRIIGGHHTT #

 Copyright 2020 Chad Granum <exodist@cpan.org>.

 This program is free software; you can redistribute it and/or modify it
 under the same terms as Perl itself.

 See _h_t_t_p_:_/_/_d_e_v_._p_e_r_l_._o_r_g_/_l_i_c_e_n_s_e_s_/

perl v5.36.3 2023-02-15 Test2::EventFacet::Control(3p)