man Test2::Formatter (3): Namespace for formatters.

DESCRIPTION

This is the namespace for formatters. This is an empty package.

CREATING FORMATTERS

A formatter is any package or object with a "write($event, $num)" method.

    package Test2::Formatter::Foo;
    use strict;
    use warnings;
    sub write {
        my $self_or_class = shift;
        my ($event, $assert_num) = @_;
        ...
    }
    sub hide_buffered { 1 }
    1;

The "write" method is a method, so it either gets a class or instance. The 2 arguments are the $event object it should record, and the $assert_num which is the number of the current assertion (ok), or the last assertion if this even is not itself an assertion. The assertion number may be any integer 0 or greater, and may be undefined in some cases.

The "hide_buffered()" method must return a boolean. This is used to tell buffered subtests whether or not to send it events as they are being buffered. See ``run_subtest(...)'' in Test2::API for more information.

SOURCE

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

MAINTAINERS

Chad Granum <[email protected]>

AUTHORS

Chad Granum <[email protected]>

COPYRIGHT

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