Perl Diver 2.31
Main Environment Variables Perl Default Values Perl Config - Summary Perl Config - Full Installed Modules List Directory uptime Docs

Module Documentation
Details and documentation about a specific module, including version and documentation (if available). Note that while links to perldoc.com and search.cpan.org are provided, the module may be part of a larger distribution. If you reach a File Not Found page on either site, please try the parent module.

Test2::EventFacet::Error

Name Test2::EventFacet::Error
Version 1.302188
Located at /usr/local/share/perl5
File /usr/local/share/perl5/Test2/EventFacet/Error.pm
Is Core No
Search CPAN for this module Test2::EventFacet::Error
Documentation Test2::EventFacet::Error
Module Details Test2::EventFacet::Error


NAME

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


DESCRIPTION

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


NOTES

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


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


AUTHORS

Chad Granum <exodist@cpan.org>Chad Granum


COPYRIGHT

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

Perl Diver brought to you by ScriptSolutions.com © 1997- 2024