NAME

Test::Stream::Formatter::TAP - Standard TAP formatter

EXPERIMENTAL CODE WARNING

This is an experimental release! Test-Stream, and all its components are still in an experimental phase. This dist has been released to cpan in order to allow testers and early adopters the chance to write experimental new tools with it, or to add experimental support for it into old tools.

PLEASE DO NOT COMPLETELY CONVERT OLD TOOLS YET. This experimental release is very likely to see a lot of code churn. API's may break at any time. Test-Stream should NOT be depended on by any toolchain level tools until the experimental phase is over.

DESCRIPTION

This is what takes events and turns them into TAP.

SYNOPSIS

    use Test::Stream::Formatter::TAP;
    my $tap = Test::Stream::Formatter::TAP->new();

    # Switch to utf8
    $tap->encoding('utf8');

    $tap->write($event, $number); # Output an event

EXPORTS

OUT_STD

OUT_ERR

OUT_TODO

These are constants to identify filehandles. These constants are used by events to direct text to the correct filehandle.

METHODS

$bool = $tap->no_numbers

$tap->set_no_numbers($bool)

Use to turn numbers on and off.

$bool = $tap->no_header($bool)

$tap->set_no_header($bool)

When true, the plan will not be rendered.

$bool = $tap->no_diag

$tap->set_no_diag($bool)

When true, diagnostics will not be rendered.

$arrayref = $tap->handles

$tap->set_handles(\@handles);

Can be used to get/set the filehandles. Indexes are identified by the OUT_STD, OUT_ERR, OUT_TODO constants.

$encoding = $tap->encoding

$tap->encoding($encoding)

Get or set the encoding. By default no encoding is set, the original settings of STDOUT and STDERR are used.

This directly modifies the stored filehandles, it does not create new ones.

$tap->write($e, $num)

Write an event to the console.

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>

Kent Fredric <kentnl@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