Test2::Event::Info (3)

Leading comments

Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/Test2::Event::Info.3perl".)

NAME

Test2::Event::Info - Info event base class

DESCRIPTION

Successor for note and diag events. This event base class supports multiple formats. This event makes it possible to send additional information such as color and highlighting to the harness.

SYNOPSIS

    use Test2::API::Context qw/context/;

    $ctx->info($obj, diagnostics => $bool);

FORMATS

Format will be passed in to "render()" and "summary()" as a string. Any string is considered valid, if your event does not recognize the format it should fallback to 'text'.

'text'

Plain and ordinary text.

'ansi'

Text that may include ansi sequences such as colors.

'html'

HTML

formatted text.

ACCESSORS

$bool = $info->diagnostics()

$info->set_diagnostics($bool)

True if this info is essential for diagnostics. The implication is that diagnostics will got to

STDERR

while everything else goes to

STDOUT,

but that is formatter/harness specific.

SOURCE

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

MAINTAINERS

Chad Granum <exodist@cpan.org>

AUTHORS

Chad Granum <exodist@cpan.org>

COPYRIGHT

Copyright 2016 Chad Granum <exodist@cpan.org>.

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

See dev.perl.org/licenses