Specio::DeclaredAt
Section: User Contributed Perl Documentation (3)
Updated: 2021-01-31
Page Index
NAME
Specio::DeclaredAt - A class to represent where a type or coercion was declared
VERSION
version 0.47
SYNOPSIS
my $declared = Specio::DeclaredAt->new_from_caller(1);
print $declared->description;
DESCRIPTION
This class provides a thin wrapper around some of the return values from Perl's
"caller" built-in. It's used internally to identify where types and coercions
are being declared, which is useful when generating error messages.
API
This class provides the following methods.
Specio::DeclaredAt->new_from_caller($depth)
Given a call stack depth, this method returns a new
"Specio::DeclaredAt"
object.
$declared_at->package, $declared_at->filename, $declared_at->line
Returns the call stack information recorded when the object was created. These
values are always populated.
$declared_at->subroutine
Returns the subroutine from the call stack. This may be an
"udnef"
$declared_at->has_subroutine
Returns true if there is a subroutine name associated with this object.
$declared_at->description
Puts all the information together into a single string like ``declared in
package Foo::Bar (.../Foo/Bar.pm) at line 42 in sub named blah''.
SUPPORT
Bugs may be submitted at <
https://github.com/houseabsolute/Specio/issues>.
I am also usually active on IRC as 'autarch' on "irc://irc.perl.org".
SOURCE
The source code repository for Specio can be found at <
https://github.com/houseabsolute/Specio>.
AUTHOR
Dave Rolsky <
autarch@urth.org>
COPYRIGHT AND LICENSE
This software is Copyright (c) 2012 - 2021 by Dave Rolsky.
This is free software, licensed under:
The Artistic License 2.0 (GPL Compatible)
The full text of the license can be found in the
LICENSE file included with this distribution.