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

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

NNAAMMEE #

 Test2::EventFacet::Info::Table - Intermediary representation of a table.

DDEESSCCRRIIPPTTIIOONN #

 Intermediary representation of a table for use in specialized
 Test::API::Context methods which generate Test2::EventFacet::Info facets.

SSYYNNOOPPSSIISS #

     use Test2::EventFacet::Info::Table;
     use Test2::API qw/context/;

     sub my_tool {
         my $ctx = context();

         ...

         $ctx->fail(
             $name,
             "failure diag message",
             Test2::EventFacet::Info::Table->new(
                 # Required
                 rows => [['a', 'b'], ['c', 'd'], ...],

                 # Strongly Recommended
                 as_string => "... string to print when table cannot be rendered ...",

                 # Optional
                 header => ['col1', 'col2'],
                 collapse => $bool,
                 no_collapse => ['col1', ...],
             ),
         );

         ...

         $ctx->release;
     }

     my_tool();

AATTTTRRIIBBUUTTEESS #

 $header_aref = $t->hheeaaddeerr(())
 $rows_aref = $t->rroowwss(())
 $bool = $t->ccoollllaappssee(())
 $aref = $t->nnoo__ccoollllaappssee(())
     The above are all directly tied to the table hashref structure
     described in Test2::EventFacet::Info.

 $str = $t->aass__ssttrriinngg(())
     This returns the string form of the table if it was set, otherwise it
     returns the string "<TABLE NOT DISPLAYED>".

 $href = $t->aass__hhaasshh(())
     This returns the data structure used for tables by
     Test2::EventFacet::Info.

 %args = $t->iinnffoo__aarrggss(())
     This returns the arguments that should be used to construct the
     proper Test2::EventFacet::Info structure.

         return (table => $t->as_hash(), details => $t->as_string());

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