Stratadox\Parser\Parsers\Optional

Complexity

Total Complexity

3

Size/Duplication

Total Lines	12
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	1	1
A	ignored()	0	3	1
A	parse()	0	3	1

<?php declare(strict_types=1);

namespace Stratadox\Parser\Parsers;

use Stratadox\Parser\Helpers\Cast;
use Stratadox\Parser\Parser;
use Stratadox\Parser\Result;
use Stratadox\Parser\Results\Skip;

/**
 * Optional
 *
 * Ignores the parser, yielding a skip result whether the parser succeeds or not.
 */
final class Optional extends Parser
{
    public function __construct(private Parser $parser) {}

    public static function ignored(Parser|string $parser): Parser
    {
        return new self(Cast::asParser($parser));
    }

    public function parse(string $input): Result
    {
        return Skip::upTo($this->parser->parse($input)->unparsed());
    }
}