Add built local::lib

[catagits/Gitalist.git] / local-lib5 / man / man3 / MooseX::Meta::TypeConstraint::Structured.3pm

.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "MooseX::Meta::TypeConstraint::Structured 3"
.TH MooseX::Meta::TypeConstraint::Structured 3 "2010-03-26" "perl v5.8.8" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
MooseX::Meta::TypeConstraint::Structured \- Structured type constraints.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A structure is a set of Moose::Meta::TypeConstraint that are 'aggregated' in
such a way as that they are all applied to an incoming list of arguments.  The
idea here is that a Type Constraint could be something like, \*(L"An Int followed by
an Int and then a Str\*(R" and that this could be done so with a declaration like:
.PP
.Vb 1
\&    Tuple[Int,Int,Str]; ## Example syntax
.Ve
.PP
So a structure is a list of Type constraints (the \*(L"Int,Int,Str\*(R" in the above
example) which are intended to function together.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
This class defines the following attributes.
.SS "type_constraints"
.IX Subsection "type_constraints"
A list of Moose::Meta::TypeConstraint objects.
.SS "constraint_generator"
.IX Subsection "constraint_generator"
A subref or closure that contains the way we validate incoming values against
a set of type constraints.
.SH "METHODS"
.IX Header "METHODS"
This class defines the following methods.
.SS "new"
.IX Subsection "new"
Initialization stuff.
.SS "validate"
.IX Subsection "validate"
Messing with validate so that we can support niced error messages.
.SS "generate_constraint_for ($type_constraints)"
.IX Subsection "generate_constraint_for ($type_constraints)"
Given some type constraints, use them to generate validation rules for an ref
of values (to be passed at check time)
.SS "parameterize (@type_constraints)"
.IX Subsection "parameterize (@type_constraints)"
Given a ref of type constraints, create a structured type.
.SS "_\|_infer_constraint_generator"
.IX Subsection "__infer_constraint_generator"
This returns a \s-1CODEREF\s0 which generates a suitable constraint generator.  Not
user servicable, you'll never call this directly.
.SS "compile_type_constraint"
.IX Subsection "compile_type_constraint"
hook into compile_type_constraint so we can set the correct validation rules.
.SS "create_child_type"
.IX Subsection "create_child_type"
modifier to make sure we get the constraint_generator
.SS "is_a_type_of"
.IX Subsection "is_a_type_of"
.SS "is_subtype_of"
.IX Subsection "is_subtype_of"
.SS "equals"
.IX Subsection "equals"
Override the base class behavior.
.SS "type_constraints_equals"
.IX Subsection "type_constraints_equals"
Checks to see if the internal type constraints are equal.
.SS "get_message"
.IX Subsection "get_message"
Give you a better peek into what's causing the error.  For now we stringify the
incoming deep value with Devel::PartialDump and pass that on to either your
custom error message or the default one.  In the future we'll try to provide a
more complete stack trace of the actual offending elements
.SH "SEE ALSO"
.IX Header "SEE ALSO"
The following modules or resources may be of interest.
.PP
Moose, Moose::Meta::TypeConstraint
.SH "AUTHOR"
.IX Header "AUTHOR"
John Napiorkowski, \f(CW\*(C`<jjnapiork@cpan.org>\*(C'\fR
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
This program is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.