summaryrefslogtreecommitdiffstats
path: root/lib/Try.pm
blob: c23a82cd96ece8fb413fcb586730489645e17355 (plain) (blame)
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
package Try;
use strict;
use warnings;
# ABSTRACT: nicer exception handling syntax

use Devel::CallParser;
use XSLoader;

XSLoader::load(
    __PACKAGE__,
    exists $Try::{VERSION} ? ${ $Try::{VERSION} } : (),
);

use Exporter 'import';
our @EXPORT = our @EXPORT_OK = ('try');

use Try::Tiny ();

=head1 SYNOPSIS

    try {
        die "foo";
    }
    catch {
        when (/foo/) {
            warn "Caught foo";
        }
    }

=head1 DESCRIPTION

This module implements a try/catch/finally statement. It is based heavily on
(and mostly implemented via) L<Try::Tiny>. The differences are:

=over 4

=item *

It is a statement. C<< my $foo = try { ... } >> doesn't work anymore, but in
return, you don't have to remember the trailing semicolon anymore. C<eval>
still works fine if you need an expression (in 5.14+ at least).

=item *

The blocks are ordered, and only one catch and finally block are supported.
C<< try { } finally { } catch { } >> and
C<< try { } catch { } finally { } finally { } >> do not work with this module,
mostly because that's just extra complexity for no real purpose.

=item *

C<catch> and C<finally> are no longer exported - they are just part of the
syntax of the C<try> statement. This is almost certainly not an issue.

=back

=cut

=head1 EXPORTS

=head2 try

C<try> takes a block to run, and catch exceptions from. The block can
optionally be followed by C<catch> and another block and C<finally> and another
block. The C<catch> block is run when the C<try> block throws an exception, and
the exception thrown will be in both C<$_> and C<@_>. The C<finally> block will
be run after the C<try> and C<catch> blocks regardless of what happens, even if
the C<catch> block rethrows the exception. The exception thrown will be in
C<@_> but B<not> C<$_> (this may change in the future, since I'm pretty sure
the reasoning for this is no longer useful in 5.14).

=cut

sub try {
    my ($try, $catch, $finally) = @_;
    &Try::Tiny::try(
        $try,
        ($catch   ? (&Try::Tiny::catch($catch))     : ()),
        ($finally ? (&Try::Tiny::finally($finally)) : ()),
    );
}

=head1 BUGS

No known bugs.

Please report any bugs through RT: email
C<bug-try at rt.cpan.org>, or browse to
L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Try>.

=head1 SEE ALSO

L<Try::Tiny>, L<TryCatch>

=head1 SUPPORT

You can find this documentation for this module with the perldoc command.

    perldoc Try

You can also look for information at:

=over 4

=item * AnnoCPAN: Annotated CPAN documentation

L<http://annocpan.org/dist/Try>

=item * CPAN Ratings

L<http://cpanratings.perl.org/d/Try>

=item * RT: CPAN's request tracker

L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Try>

=item * Search CPAN

L<http://search.cpan.org/dist/Try>

=back

=cut

1;