TAP::Parser::Result::Plan(3p)

TAP::Parser::Result::Plan3p

Plan result token.

Version

Version 3.50

Overview

This is a subclass of TAP::Parser::Result. A token of this class will be returned if a plan line is encountered.

 1..1
 ok 1 - woo hooo!

1..1 is the plan. Gotta have a plan.

Overridden methods

Mainly listed here to shut up the pitiful screams of the pod coverage tests. They keep me awake at night.

•

"as_string"

•

"raw"

Instance Methods

"plan"

  if ( $result->is_plan ) {
     print $result->plan;
  }

This is merely a synonym for "as_string".

"tests_planned"

  my $planned = $result->tests_planned;

Returns the number of tests planned. For example, a plan of 1..17 will cause this method to return '17'.

"directive"

 my $directive = $plan->directive;

If a SKIP directive is included with the plan, this method will return it.

 1..0 # SKIP: why bother?

"has_skip"

  if ( $result->has_skip ) { ... }

Returns a boolean value indicating whether or not this test has a SKIP directive.

"explanation"

 my $explanation = $plan->explanation;

If a SKIP directive was included with the plan, this method will return the explanation, if any.

"todo_list"

  my $todo = $result->todo_list;
  for ( @$todo ) {
      ...
  }

Releases

32 releases since OpenBSD 5.0; the text changed 20 times.

  1. 5.0–5.3
  2. 5.4–5.5
  3. 5.6
  4. 5.7
  5. 5.8–5.9
  6. 6.0
  7. 6.1
  8. 6.2
  9. 6.3–6.4
  10. 6.5
  11. 6.6
  12. 6.7
  13. 6.8
  14. 6.9–7.2
  15. 7.3
  16. 7.4
  17. 7.5
  18. 7.6
  19. 7.7–7.8
  20. 7.9
  21. 8.0

From man 8.0-current-20261101 in OpenBSD 8.0-current (2026-11-01). Parsed by carta from the page's man source.