view release on metacpan or  search on metacpan

lib/Path/Router/Route/Match.pm  view on Meta::CPAN

package Path::Router::Route::Match;
our $AUTHORITY = 'cpan:STEVAN';
$Path::Router::Route::Match::VERSION = '0.15';
use Types::Standard  1.000005 qw(Str HashRef InstanceOf);

use Moo              2.000001;
use namespace::clean 0.23;
# ABSTRACT: The result of a Path::Router match


has 'path'    => (is => 'ro', isa => Str,     required => 1);
has 'mapping' => (is => 'ro', isa => HashRef, required => 1);

has 'route'   => (
    is       => 'ro',
    isa      => InstanceOf['Path::Router::Route'],
    required => 1,
    handles  => [qw[target]]
);

1;

__END__

=pod

=encoding UTF-8

=head1 NAME

Path::Router::Route::Match - The result of a Path::Router match

=head1 VERSION

version 0.15

=head1 DESCRIPTION

This is the object returned from calling C<match> on a L<Path::Router>
instance. It contains all the information you would need to do any
dispatching nessecary.

=head1 METHODS

=over 4

=item B<new>

=item B<path>

This is the path that was matched.

=item B<mapping>

This is the mapping of your router part names to the actual parts of
the path. If your route had no "variables", then this will be an empty
HASH ref.

=item B<route>

This is the L<Path::Router::Route> instance that was matched.

=item B<target>

This method simply delegates to the C<target> method of the C<route>
that was matched.

=item B<meta>

=back

=head1 BUGS