15759b3d2Safresh1package Test2::EventFacet::Error; 25759b3d2Safresh1use strict; 35759b3d2Safresh1use warnings; 45759b3d2Safresh1 5*5486feefSafresh1our $VERSION = '1.302199'; 65759b3d2Safresh1 75759b3d2Safresh1sub facet_key { 'errors' } 85759b3d2Safresh1sub is_list { 1 } 95759b3d2Safresh1 105759b3d2Safresh1BEGIN { require Test2::EventFacet; our @ISA = qw(Test2::EventFacet) } 115759b3d2Safresh1use Test2::Util::HashBase qw{ -tag -fail }; 125759b3d2Safresh1 135759b3d2Safresh11; 145759b3d2Safresh1 155759b3d2Safresh1__END__ 165759b3d2Safresh1 175759b3d2Safresh1=pod 185759b3d2Safresh1 195759b3d2Safresh1=encoding UTF-8 205759b3d2Safresh1 215759b3d2Safresh1=head1 NAME 225759b3d2Safresh1 235759b3d2Safresh1Test2::EventFacet::Error - Facet for errors that need to be shown. 245759b3d2Safresh1 255759b3d2Safresh1=head1 DESCRIPTION 265759b3d2Safresh1 275759b3d2Safresh1This facet is used when an event needs to convey errors. 285759b3d2Safresh1 295759b3d2Safresh1=head1 NOTES 305759b3d2Safresh1 315759b3d2Safresh1This facet has the hash key C<'errors'>, and is a list of facets instead of a 325759b3d2Safresh1single item. 335759b3d2Safresh1 345759b3d2Safresh1=head1 FIELDS 355759b3d2Safresh1 365759b3d2Safresh1=over 4 375759b3d2Safresh1 385759b3d2Safresh1=item $string = $error->{details} 395759b3d2Safresh1 405759b3d2Safresh1=item $string = $error->details() 415759b3d2Safresh1 425759b3d2Safresh1Explanation of the error, or the error itself (such as an exception). In perl 435759b3d2Safresh1exceptions may be blessed objects, so this field may contain a blessed object. 445759b3d2Safresh1 455759b3d2Safresh1=item $short_string = $error->{tag} 465759b3d2Safresh1 475759b3d2Safresh1=item $short_string = $error->tag() 485759b3d2Safresh1 495759b3d2Safresh1Short tag to categorize the error. This is usually 10 characters or less, 505759b3d2Safresh1formatters may truncate longer tags. 515759b3d2Safresh1 525759b3d2Safresh1=item $bool = $error->{fail} 535759b3d2Safresh1 545759b3d2Safresh1=item $bool = $error->fail() 555759b3d2Safresh1 565759b3d2Safresh1Not all errors are fatal, some are displayed having already been handled. Set 575759b3d2Safresh1this to true if you want the error to cause the test to fail. Without this the 585759b3d2Safresh1error is simply a diagnostics message that has no effect on the overall 595759b3d2Safresh1pass/fail result. 605759b3d2Safresh1 615759b3d2Safresh1=back 625759b3d2Safresh1 635759b3d2Safresh1=head1 SOURCE 645759b3d2Safresh1 655759b3d2Safresh1The source code repository for Test2 can be found at 66*5486feefSafresh1L<https://github.com/Test-More/test-more/>. 675759b3d2Safresh1 685759b3d2Safresh1=head1 MAINTAINERS 695759b3d2Safresh1 705759b3d2Safresh1=over 4 715759b3d2Safresh1 725759b3d2Safresh1=item Chad Granum E<lt>exodist@cpan.orgE<gt> 735759b3d2Safresh1 745759b3d2Safresh1=back 755759b3d2Safresh1 765759b3d2Safresh1=head1 AUTHORS 775759b3d2Safresh1 785759b3d2Safresh1=over 4 795759b3d2Safresh1 805759b3d2Safresh1=item Chad Granum E<lt>exodist@cpan.orgE<gt> 815759b3d2Safresh1 825759b3d2Safresh1=back 835759b3d2Safresh1 845759b3d2Safresh1=head1 COPYRIGHT 855759b3d2Safresh1 86256a93a4Safresh1Copyright 2020 Chad Granum E<lt>exodist@cpan.orgE<gt>. 875759b3d2Safresh1 885759b3d2Safresh1This program is free software; you can redistribute it and/or 895759b3d2Safresh1modify it under the same terms as Perl itself. 905759b3d2Safresh1 91*5486feefSafresh1See L<https://dev.perl.org/licenses/> 925759b3d2Safresh1 935759b3d2Safresh1=cut 94