/ 
Do-1.09
River stage zero No dependents
/ Data::Object::Exception

NAME

Data::Object::Exception

ABSTRACT

Data-Object Exception Class

SYNOPSIS

use Data::Object::Exception;

my $exception = Data::Object::Exception->new;

die $exception;

$exception->throw('Oops');

die $exception->new('Oops')->trace(0);

"$exception" # renders exception message

DESCRIPTION

This package provides functionality for creating, throwing, and introspecting exception objects.

METHODS

This package implements the following methods.

data

data() : Any

Render the exception message with optional context and stack trace.

data example
my $data = $exception->data();

new

new(HashRef $arg1) : ExceptionObject

The new method expects a message, or named arguments, and returns a new class instance.

new example
# Oops

my $exception = Data::Object::Exception->new(
  message => 'Oops'
});

throw

throw(Str $arg1) : Object

Throw error with message and context.

throw example
$exception->throw();

trace

trace(Int $offset, $Int $limit) : ExceptionObject

The trace method compiles a stack trace and returns the object. By default it skips the first frame.

trace example
# $exception

my $trace = $exception->trace;
my $trace = $exception->trace(0); # all frames
my $trace = $exception->trace(0, 5); # five frames, no skip

AUTHOR

Al Newkirk, awncorp@cpan.org

LICENSE

Copyright (C) 2011-2019, Al Newkirk, et al.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

PROJECT

On GitHub

Initiatives

Contributing

Reporting

SEE ALSO

To get the most out of this distribution, consider reading the following:

Data::Object::Class

Data::Object::Role

Data::Object::Rule

Data::Object::Library

Data::Object::Signatures