Optional::ignored()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
eloc 1
c 1
b 0
f 0
dl 0
loc 3
rs 10
cc 1
nc 1
nop 1
1
<?php declare(strict_types=1);
2
3
namespace Stratadox\Parser\Parsers;
4
5
use Stratadox\Parser\Helpers\Cast;
6
use Stratadox\Parser\Parser;
7
use Stratadox\Parser\Result;
8
use Stratadox\Parser\Results\Skip;
9
10
/**
11
 * Optional
12
 *
13
 * Ignores the parser, yielding a skip result whether the parser succeeds or not.
14
 */
15
final class Optional extends Parser
16
{
17
    public function __construct(private Parser $parser) {}
18
19
    public static function ignored(Parser|string $parser): Parser
20
    {
21
        return new self(Cast::asParser($parser));
22
    }
23
24
    public function parse(string $input): Result
25
    {
26
        return Skip::upTo($this->parser->parse($input)->unparsed());
27
    }
28
}
29