Perl Diver 2.31
Main Environment Variables Perl Default Values Perl Config - Summary Perl Config - Full Installed Modules List Directory uptime Docs

Module Documentation
Details and documentation about a specific module, including version and documentation (if available). Note that while links to perldoc.com and search.cpan.org are provided, the module may be part of a larger distribution. If you reach a File Not Found page on either site, please try the parent module.

Type::Parser

Name Type::Parser
Version 1.004004
Located at /usr/share/perl5/vendor_perl
File /usr/share/perl5/vendor_perl/Type/Parser.pm
Is Core No
Search CPAN for this module Type::Parser
Documentation Type::Parser
Module Details Type::Parser


NAME

Type::Parser - parse type constraint strings


SYNOPSIS

 use v5.10;
 use strict;
 use warnings;

 use Type::Parser qw( eval_type );
 use Type::Registry;

 my $reg = Type::Registry->for_me;
 $reg->add_types("Types::Standard");

 my $type = eval_type("Int | ArrayRef[Int]", $reg);

 $type->check(10);        # true
 $type->check([1..4]);    # true
 $type->check({foo=>1});  # false


STATUS

This module is covered by the Type-Tiny stability policy.


DESCRIPTION

Generally speaking, you probably don't want to be using this module directly. Instead use the lookup method from the Type::Registry manpage which wraps it.

Functions

parse($string)
Parse the type constraint string into something like an AST.

If called in list context, also returns any ``tail'' found on the original string.

extract_type($string, $registry)
Compile a type constraint string into a the Type::Tiny manpage object.

If called in list context, also returns any ``tail'' found on the original string.

eval_type($string, $registry)
Compile a type constraint string into a the Type::Tiny manpage object.

Throws an error if the ``tail'' contains any non-whitespace character.

Constants

The following constants correspond to values returned by $token->type.

TYPE
QUOTELIKE
STRING
CLASS
L_BRACKET
R_BRACKET
COMMA
SLURPY
UNION
INTERSECT
NOT
L_PAREN
R_PAREN
MYSTERY


BUGS

Please report any bugs to http://rt.cpan.org/Dist/Display.html.


SEE ALSO

the Type::Registry manpage.


AUTHOR

Toby Inkster <tobyink@cpan.org>.


COPYRIGHT AND LICENCE

This software is copyright (c) 2013-2014, 2017-2019 by Toby Inkster.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.


DISCLAIMER OF WARRANTIES

THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.

Perl Diver brought to you by ScriptSolutions.com © 1997- 2024