<html><head><meta name="color-scheme" content="light dark"></head><body><pre style="word-wrap: break-word; white-space: pre-wrap;">package Test2::EventFacet::Plan;
use strict;
use warnings;

our $VERSION = '1.302199';

BEGIN { require Test2::EventFacet; our @ISA = qw(Test2::EventFacet) }
use Test2::Util::HashBase qw{ -count -skip -none };

1;

__END__

=pod

=encoding UTF-8

=head1 NAME

Test2::EventFacet::Plan - Facet for setting the plan

=head1 DESCRIPTION

Events use this facet when they need to set the plan.

=head1 FIELDS

=over 4

=item $string = $plan-&gt;{details}

=item $string = $plan-&gt;details()

Human readable explanation for the plan being set. This is normally not
rendered by most formatters except when the C&lt;skip&gt; field is also set.

=item $positive_int = $plan-&gt;{count}

=item $positive_int = $plan-&gt;count()

Set the number of expected assertions. This should usually be set to C&lt;0&gt; when
C&lt;skip&gt; or C&lt;none&gt; are also set.

=item $bool = $plan-&gt;{skip}

=item $bool = $plan-&gt;skip()

When true the entire test should be skipped. This is usually paired with an
explanation in the C&lt;details&gt; field, and a C&lt;control&gt; facet that has
C&lt;terminate&gt; set to C&lt;0&gt;.

=item $bool = $plan-&gt;{none}

=item $bool = $plan-&gt;none()

This is mainly used by legacy L&lt;Test::Builder&gt; tests which set the plan to C&lt;no
plan&gt;, a construct that predates the much better C&lt;done_testing()&gt;.

If you are using this in non-legacy code you may need to reconsider the course
of your life, maybe a hermitage would suite you?

=back

=head1 SOURCE

The source code repository for Test2 can be found at
L&lt;https://github.com/Test-More/test-more/&gt;.

=head1 MAINTAINERS

=over 4

=item Chad Granum E&lt;lt&gt;exodist@cpan.orgE&lt;gt&gt;

=back

=head1 AUTHORS

=over 4

=item Chad Granum E&lt;lt&gt;exodist@cpan.orgE&lt;gt&gt;

=back

=head1 COPYRIGHT

Copyright 2020 Chad Granum E&lt;lt&gt;exodist@cpan.orgE&lt;gt&gt;.

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

See L&lt;https://dev.perl.org/licenses/&gt;

=cut
</pre></body></html>