<!-- GENERATED by docs/sphinx/bin/20-reference (p5) from reference/bundled/TAP/Parser/Result.md. Do not edit. -->

```{index} single: TAP::Parser::Result
```

# TAP::Parser::Result

Base class for TAP::Parser output objects

## VERSION

Version 3.52

## SYNOPSIS

```perl
## abstract class - not meant to be used directly
## see TAP::Parser::ResultFactory for preferred usage

## directly:
use TAP::Parser::Result;
my $token  = {...};
my $result = TAP::Parser::Result->new( $token );
```

### DESCRIPTION

This is a simple base class used by [TAP::Parser](../Parser.md) to store objects that
represent the current bit of test output data from TAP (usually a single
line).  Unless you're subclassing, you probably won't need to use this module
directly.

### METHODS

#### `new`

```perl
## see TAP::Parser::ResultFactory for preferred usage

## to use directly:
my $result = TAP::Parser::Result->new($token);
```

Returns an instance the appropriate class for the test token passed in.

### Boolean methods

The following methods all return a boolean value and are to be overridden in
the appropriate subclass.

- `is_plan`

    Indicates whether or not this is the test plan line.

    ```text
    1..3
    ```

- `is_pragma`

    Indicates whether or not this is a pragma line.

    ```text
    pragma +strict
    ```

- `is_test`

    Indicates whether or not this is a test line.

    ```text
    ok 1 Is OK!
    ```

- `is_comment`

    Indicates whether or not this is a comment.

    ```text
    # this is a comment
    ```

- `is_bailout`

    Indicates whether or not this is bailout line.

    ```text
    Bail out! We're out of dilithium crystals.
    ```

- `is_version`

    Indicates whether or not this is a TAP version line.

    ```text
    TAP version 4
    ```

- `is_unknown`

    Indicates whether or not the current line could be parsed.

    ```text
    ... this line is junk ...
    ```

- `is_yaml`

    Indicates whether or not this is a YAML chunk.

#### `raw`

```perl
print $result->raw;
```

Returns the original line of text which was parsed.

#### `type`

```perl
my $type = $result->type;
```

Returns the "type" of a token, such as `comment` or `test`.

#### `as_string`

```perl
print $result->as_string;
```

Prints a string representation of the token.  This might not be the exact
output, however.  Tests will have test numbers added if not present, TODO and
SKIP directives will be capitalized and, in general, things will be cleaned
up.  If you need the original text for the token, see the `raw` method.

#### `is_ok`

```perl
if ( $result->is_ok ) { ... }
```

Reports whether or not a given result has passed.  Anything which is **not** a
test result returns true.  This is merely provided as a convenient shortcut.

#### `passed`

Deprecated.  Please use `is_ok` instead.

#### `has_directive`

```perl
if ( $result->has_directive ) {
   ...
}
```

Indicates whether or not the given result has a TODO or SKIP directive.

#### `has_todo`

```perl
if ( $result->has_todo ) {
    ...
}
```

Indicates whether or not the given result has a TODO directive.

#### `has_skip`

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

Indicates whether or not the given result has a SKIP directive.

#### `set_directive`

Set the directive associated with this token. Used internally to fake
TODO tests.

## SUBCLASSING

Please see ["SUBCLASSING" in TAP::Parser](../Parser.md) for a subclassing overview.

Remember: if you want your subclass to be automatically used by the parser,
you'll have to register it with ["register\_type" in TAP::Parser::ResultFactory](ResultFactory.md).

If you're creating a completely new result _type_, you'll probably need to
subclass [TAP::Parser::Grammar](Grammar.md) too, or else it'll never get used.

### Example

```perl
package MyResult;

use strict;

use base 'TAP::Parser::Result';

## register with the factory:
TAP::Parser::ResultFactory->register_type( 'my_type' => __PACKAGE__ );

sub as_string { 'My results all look the same' }
```

## SEE ALSO

[TAP::Object](../Object.md),
[TAP::Parser](../Parser.md),
[TAP::Parser::ResultFactory](ResultFactory.md),
[TAP::Parser::Result::Bailout](Result/Bailout.md),
[TAP::Parser::Result::Comment](Result/Comment.md),
[TAP::Parser::Result::Plan](Result/Plan.md),
[TAP::Parser::Result::Pragma](Result/Pragma.md),
[TAP::Parser::Result::Test](Result/Test.md),
[TAP::Parser::Result::Unknown](Result/Unknown.md),
[TAP::Parser::Result::Version](Result/Version.md),
[TAP::Parser::Result::YAML](Result/YAML.md),

## Modules

- [`TAP::Parser::Result::Bailout`](Result/Bailout.md) - Bailout result token.
- [`TAP::Parser::Result::Comment`](Result/Comment.md) - Comment result token.
- [`TAP::Parser::Result::Plan`](Result/Plan.md) - Plan result token.
- [`TAP::Parser::Result::Pragma`](Result/Pragma.md) - TAP pragma token.
- [`TAP::Parser::Result::Test`](Result/Test.md) - Test result token.
- [`TAP::Parser::Result::Unknown`](Result/Unknown.md) - Unknown result token.
- [`TAP::Parser::Result::Version`](Result/Version.md) - TAP syntax version token.
- [`TAP::Parser::Result::YAML`](Result/YAML.md) - YAML result token.

```{toctree}
:hidden:
:maxdepth: 1

Result/Bailout
Result/Comment
Result/Plan
Result/Pragma
Result/Test
Result/Unknown
Result/Version
Result/YAML
```