Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

Test2::EventFacet::Error (3)

Name

Test2::EventFacet::Error - Facet for errors that need to be shown.

Synopsis

Please see following description for synopsis

Description

Perl Programmers Reference Guide
                                                   Test2::EventFacet::Error(3)



NAME
       Test2::EventFacet::Error - Facet for errors that need to be shown.

DESCRIPTION
       This facet is used when an event needs to convey errors.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | runtime/perl-532      |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+

NOTES
       This facet has the hash key 'errors', and is a list of facets instead
       of a single item.

       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       http://www.cpan.org/src/5.0/perl-5.32.0.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.perl.org/.

FIELDS
       $string = $error->{details}
       $string = $error->details()
           Explanation of the error, or the error itself (such as an
           exception). In perl exceptions may be blessed objects, so this
           field may contain a blessed object.

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

       $bool = $error->{fail}
       $bool = $error->fail()
           Not all errors are fatal, some are displayed having already been
           handled. Set this to true if you want the error to cause the test
           to fail. Without this the error is simply a diagnostics message
           that has no effect on the overall pass/fail result.

SOURCE
       The source code repository for Test2 can be found at
       http://github.com/Test-More/test-more/.

MAINTAINERS
       Chad Granum <exodist@cpan.org>

AUTHORS
       Chad Granum <exodist@cpan.org>

COPYRIGHT
       Copyright 2019 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 http://dev.perl.org/licenses/




perl v5.32.0                      2020-06-14
                                                   Test2::EventFacet::Error(3)