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

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

NNAAMMEE #

 Test2::EventFacet::Info - Facet for information a developer might care
 about.

DDEESSCCRRIIPPTTIIOONN #

 This facet represents messages intended for humans that will help them
 either understand a result, or diagnose a failure.

NNOOTTEESS #

 This facet appears in a list instead of being a single item.

FFIIEELLDDSS #

 $string_or_structure = $info->{details}
 $string_or_structure = $info->ddeettaaiillss(())
     Human readable string or data structure, this is the information to
     display.  Formatters are free to render the structures however they
     please. This may contain a blessed object.

     If the "table" attribute (see below) is set then a renderer may
     choose to display the table instead of the details.

 $structure = $info->{table}
 $structure = $info->ttaabbllee(())
     If the data the "info" facet needs to convey can be represented as a
     table then the data may be placed in this attribute in a more raw
     form for better display. The data must also be represented in the
     "details" attribute for renderers which do not support rendering
     tables directly.

     The table structure:

         my %table = {
             header => [ 'column 1 header', 'column 2 header', ... ], # Optional

             rows => [
                 ['row 1 column 1', 'row 1, column 2', ... ],
                 ['row 2 column 1', 'row 2, column 2', ... ],
                 ...
             ],

             # Allow the renderer to hide empty columns when true, Optional
             collapse => $BOOL,

             # List by name or number columns that should never be collapsed
             no_collapse => \@LIST,
         }

 $short_string = $info->{tag}
 $short_string = $info->ttaagg(())
     Short tag to categorize the info. This is usually 10 characters or
     less, formatters may truncate longer tags.

 $bool = $info->{debug}
 $bool = $info->ddeebbuugg(())
     Set this to true if the message is critical, or explains a failure.
     This is info that should be displayed by formatters even in less-
     verbose modes.

     When false the information is not considered critical and may not be
     rendered in less-verbose modes.

 $bool = $info->{important}
 $bool = $info->important
     This should be set for non debug messages that are still important
     enough to show when a formatter is in quiet mode. A formatter should
     send these to STDOUT not STDERR, but should show them even in non-
     verbose mode.

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::Info(3p)