Class::Usul::Exception - Exception handling
use Class::Usul::Functions qw(throw); use Try::Tiny; sub some_method { my $self = shift; try { this_will_fail } catch { throw $_ }; } # OR use Class::Usul::Exception; sub some_method { my $self = shift; eval { this_will_fail }; Class::Usul::Exception->throw_on_error; } # THEN try { $self->some_method() } catch { warn $_."\n\n".$_->stacktrace."\n" };
An exception class that supports error messages with placeholders, a "throw" method with automatic re-throw upon detection of self, conditional throw if an exception was caught and a simplified stacktrace
Error objects are overloaded to stringify to the full error message plus a leader
The __PACKAGE__->ignore_class class method contains a classes whose presence should be ignored by the error message leader
__PACKAGE__->ignore_class
Defines the following list of read only attributes;
args
An array ref of parameters substituted in for the placeholders in the error message when the error is localised
class
Defaults to __PACKAGE__. Can be used to differentiate different classes of error
__PACKAGE__
error
The actually error message which defaults to Unknown error. Can contain placeholders of the form [_<n>] where <n> is an integer starting at one
Unknown error
[_<n>]
<n>
leader
Set to the package and line number where the error should be reported
level
A positive integer which defaults to one. How many additional stack frames to pop before calculating the leader attribute
out
Defaults to null. May contain the output from whatever just threw the exception
rv
Return value which defaults to one
time
A positive integer which defaults to the CORE::time the exception was thrown
CORE::time
BUILDARGS
Doesn't modify the BUILDARGS method. This is here to workaround a bug in Moo and / or Test::Pod::Coverage
as_string
$error_text = $self->as_string;
This is what the object stringifies to, including the leader attribute
caught
$self = $class->caught( [ @args ] );
Catches and returns a thrown exception or generates a new exception if $EVAL_ERROR has been set. Returns either an exception object or undef
$EVAL_ERROR
clone
$cloned_exception_object_ref = $self->clone( $args );
Returns a clone of the invocant. The optional $args hash reference mutates the returned clone
$args
stacktrace
$lines = $self->stacktrace( $num_lines_to_skip );
Return the stack trace. Defaults to skipping zero lines of output
throw
$class->throw 'Path [_1] not found', [ 'pathname' ];
Create (or re-throw) an exception. If the passed parameter is a blessed reference it is re-thrown. If a single scalar is passed it is taken to be an error message, a new exception is created with all other parameters taking their default values. If more than one parameter is passed the it is treated as a list and used to instantiate the new exception. The 'error' parameter must be provided in this case
throw_on_error
$class->throw_on_error( [ @args ] );
Calls "caught" passing in the options @args and if there was an exception "throw"s it
@args
None
There are no known incompatibilities in this module
There are no known bugs in this module. Please report problems to the address below. Patches are welcome
Peter Flanigan <pjfl@cpan.org>
<pjfl@cpan.org>
Copyright (c) 2018 Peter Flanigan. All rights reserved
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic
This program is distributed in the hope that it will be useful, but WITHOUT WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE
To install Class::Usul, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Class::Usul
CPAN shell
perl -MCPAN -e shell install Class::Usul
For more information on module installation, please visit the detailed CPAN module installation guide.