NAME

Test::Stream::DebugInfo - Debug information for events

DESCRIPTION

All events need to have access to information about where they were created, as well as if they are todo, or part of a skipped test. This object represents that information.

SYNOPSIS

    use Test::Stream::DebugInfo;

    my $dbg = Test::Stream::DebugInfo->new(
        frame => [$package, $file, $line, $subname],
    );

METHODS

$dbg->set_todo($reason)

$reason = $dbg->todo

Get/Set/Unset todo for the current debug-info.

$dbg->set_skip($reason)

$reason = $dbg->skip

Get/Set/Unset skip for the current debug-info.

$dbg->set_detail($msg)

$msg = $dbg->detail

Used to get/set a custom trace message that will be used INSTEAD of at <FILE> line <LINE> when calling $dbg->trace.

$dbg->trace

Typically returns the string at <FILE> line <LINE>. If detail is set then its value wil be returned instead.

$dbg->alert($MESSAGE)

This issues a warning at the frame (filename and line number where errors should be reported).

$dbg->throw($MESSAGE)

This throws an exception at the frame (filename and line number where errors should be reported).

$frame = $dbg->frame()

Get the call frame arrayref.

($package, $file, $line, $subname) = $dbg->call()

Get the caller details for the debug-info. This is where errors should be reported.

$pkg = $dbg->package

Get the debug-info package.

$file = $dbg->file

Get the debug-info filename.

$line = $dbg->line

Get the debug-info line number.

$subname = $dbg->subname

Get the debug-info subroutine name.

SOURCE

The source code repository for Test::Stream can be found at http://github.com/Test-More/Test-Stream/.

MAINTAINERS

Chad Granum <exodist@cpan.org>

AUTHORS

Chad Granum <exodist@cpan.org>

COPYRIGHT

Copyright 2015 Chad Granum <exodist7@gmail.com>.

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

See http://www.perl.com/perl/misc/Artistic.html