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::RULE (3)

.ds Aq ’

NAME

Path::Dispatcher::Rule - predicate and codeblock

CONTENTS

SYNOPSIS



    my $rule = Path::Dispatcher::Rule::Regex->new(
        regex => qr/^quit/,
        block => sub { die "Program terminated by user.\n" },
    );

    $rule->match("die"); # undef, because "die" !~ /^quit/

    my $match = $rule->match("quit"); # creates a Path::Dispatcher::Match

    $match->run; # exits the program



DESCRIPTION

A rule has a predicate and an optional codeblock. Rules can be matched (which checks the predicate against the path) and they can be ran (which invokes the codeblock).

This class is not meant to be instantiated directly, because there is no predicate matching function. Instead use one of the subclasses such as Path::Dispatcher::Rule::Tokens.

ATTRIBUTES

    block

An optional block of code to be run. Please use the run method instead of invoking this attribute directly.

    prefix

A boolean indicating whether this rule can match a prefix of a path. If false, then the predicate must match the entire path. One use-case is that you may want a catch-all rule that matches anything beginning with the token ticket. The unmatched, latter part of the path will be available in the match object.

METHODS

    match path -> match

Takes a path and returns a Path::Dispatcher::Match object if it matched the predicate, otherwise undef. The match object contains information about the match, such as the results (e.g. for regex, a list of the captured variables), the leftover path if prefix matching was used, etc.

    run

Runs the rule’s codeblock. If none is present, it throws an exception.
Search for    or go to Top of page |  Section 3 |  Main Index


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

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