GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  PATH::DISPATCHER::MATCH (3)

.ds Aq ’

NAME

Path::Dispatcher::Match - the result of a successful rule match

CONTENTS

SYNOPSIS



    my $rule = Path::Dispatcher::Rule::Tokens->new(
        tokens => [ attack, qr/^\w+$/ ],
        block  => sub {
            my $match = shift;
            attack($match->pos(2))
        },
    );

    my $match = $rule->match("attack dragon");

    # introspection
    $match->path                # "attack dragon"
    $match->leftover            # empty string (populated with prefix rules)
    $match->rule                # $rule
    $match->positional_captures # ["attack", "dragon"] (decided by the rule)
    $match->pos(1)              # "attack"
    $match->pos(2)              # "dragon"

    $match->run                 # attack("dragon")



DESCRIPTION

If a Path::Dispatcher::Rule successfully matches a path, it creates one or more Path::Dispatcher::Match objects.

ATTRIBUTES

    rule

The Path::Dispatcher::Rule that created this match.

    path

The path that the rule matched.

    leftover

The rest of the path. This is populated when the rule matches a prefix of the path.

    positional_captures

Any positional captures generated by the rule. For example, Path::Dispatcher::Rule::Regex populates this with the capture variables.

    named_captures

Any named captures generated by the rule. For example, Path::Dispatcher::Rule::Regex populates this with named captures.

    parent

The parent match object, if applicable (which may be set if this match is the child of, for exampl, a Path::Dispatcher::Rule::Under prefix)

METHODS

    run

Executes the rule’s codeblock with the same arguments.

    pos($i)

Returns the $ith positional capture, 1-indexed.
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 PATH::DISPATCHER::MATCH (3) 2015-02-18

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.