1TAP::Parser::Result::PlUasne(r3)Contributed Perl DocumenTtAaPt:i:oPnarser::Result::Plan(3)
2
3
4

NAME

6       TAP::Parser::Result::Plan - Plan result token.
7

VERSION

9       Version 3.48
10

DESCRIPTION

12       This is a subclass of TAP::Parser::Result.  A token of this class will
13       be returned if a plan line is encountered.
14
15        1..1
16        ok 1 - woo hooo!
17
18       1..1 is the plan.  Gotta have a plan.
19

OVERRIDDEN METHODS

21       Mainly listed here to shut up the pitiful screams of the pod coverage
22       tests.  They keep me awake at night.
23
24       •   "as_string"
25
26       •   "raw"
27
28   Instance Methods
29       "plan"
30
31         if ( $result->is_plan ) {
32            print $result->plan;
33         }
34
35       This is merely a synonym for "as_string".
36
37       "tests_planned"
38
39         my $planned = $result->tests_planned;
40
41       Returns the number of tests planned.  For example, a plan of 1..17 will
42       cause this method to return '17'.
43
44       "directive"
45
46        my $directive = $plan->directive;
47
48       If a SKIP directive is included with the plan, this method will return
49       it.
50
51        1..0 # SKIP: why bother?
52
53       "has_skip"
54
55         if ( $result->has_skip ) { ... }
56
57       Returns a boolean value indicating whether or not this test has a SKIP
58       directive.
59
60       "explanation"
61
62        my $explanation = $plan->explanation;
63
64       If a SKIP directive was included with the plan, this method will return
65       the explanation, if any.
66
67       "todo_list"
68
69         my $todo = $result->todo_list;
70         for ( @$todo ) {
71             ...
72         }
73
74
75
76perl v5.36.1                      2023-10-03      TAP::Parser::Result::Plan(3)