From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

MARKOV / Log-Report-1.39 / lib / Log / Report / Die.pod 

            

              
—
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

              
=encoding utf8
=head1 NAME
Log::Report::Die - compatibility routines with Perl's die/croak/confess
=head1 INHERITANCE
 Log::Report::Die
   is an Exporter
=head1 SYNOPSIS
 # use internally only
=head1 DESCRIPTION
This module is used internally, to translate output of 'die' and Carp
functions into L<Log::Report::Message|Log::Report::Message> objects.  Also, it tries to
convert other kinds of exception frameworks into our message object.
=head1 FUNCTIONS
=over 4
=item B<die_decode>(STRING, %options)
The STRING is the content of C<$@> after an eval() caught a die().
croak(), or confess().  This routine tries to convert this into
parameters for L<Log::Report::report()|Log::Report/"Report Production and Configuration">.  This is done in a very
smart way, even trying to find the stringifications of C<$!>.
Returned are four elements: the error string or object which triggered
the death originally (the original $@), and the opts, reason, and plain
text message.  The opts is a HASH which, amongst other things, may contain
a stack trace and location extracted from the death text or object.
Translated components will have exception classes C<perl>, and C<die> or
C<confess>.  On the moment, the C<croak> cannot be distiguished from the
C<confess> (when used in package main) or C<die> (otherwise).
The returned reason depends on whether the translation of the current
C<$!> is found in the STRING, and the presence of a stack trace.  The
following table is used:
  errstr  stack  =>  reason
    no      no       ERROR   (die) application internal problem
    yes     no       FAULT   (die) external problem, think open()
    no      yes      PANIC   (confess) implementation error
    yes     yes      ALERT   (confess) external problem, caught
 -Option--Default
  on_die  'ERROR'
=over 2
=item on_die => REASON
=back
=item B<exception_decode>($exception, %options)
[1.23] This function attempts to translate object of other exception frameworks
into information to create a L<Log::Report::Exception|Log::Report::Exception>.  It returns the
same list of parameters as L<die_decode()|Log::Report::Die/"FUNCTIONS"> does.
Currently supported:
=over 4
=item * DBIx::Class::Exception
=item * XML::LibXML::Error
=back
=back
=head1 SEE ALSO
This module is part of Log-Report distribution version 1.39,
built on September 09, 2024. Website: F<http://perl.overmeer.net/CPAN/>
=head1 LICENSE
Copyrights 2007-2024 by [Mark Overmeer <markov@cpan.org>]. For other contributors see ChangeLog.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See F<http://dev.perl.org/licenses/>