[catagits/Gitalist.git] / local-lib5 / man / man3 / Moose::Meta::TypeCoercion.3pm

.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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.  | will give a
.\" real vertical bar.  \*(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-|\(bv\*(Tr
.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\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" 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 "Moose::Meta::TypeCoercion 3"
.TH Moose::Meta::TypeCoercion 3 "2009-11-19" "perl v5.8.7" "User Contributed Perl Documentation"
.SH "NAME"
Moose::Meta::TypeCoercion \- The Moose Type Coercion metaclass
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A type coercion object is basically a mapping of one or more type
constraints and the associated coercions subroutines.
.PP
It's unlikely that you will need to instantiate an object of this
class directly, as it's part of the deep internals of Moose.
.SH "METHODS"
.IX Header "METHODS"
.IP "\fBMoose::Meta::TypeCoercion\->new(%options)\fR" 4
.IX Item "Moose::Meta::TypeCoercion->new(%options)"
Creates a new type coercion object, based on the options provided.
.RS 4
.IP "* type_constraint" 8
.IX Item "type_constraint"
This is the Moose::Meta::TypeConstraint object for the type that is
being coerced \fIto\fR.
.RE
.RS 4
.RE
.IP "\fB$coercion\->type_coercion_map\fR" 4
.IX Item "$coercion->type_coercion_map"
This returns the map of type constraints to coercions as an array
reference. The values of the array alternate between type names and
subroutine references which implement the coercion.
.Sp
The value is an array reference because coercions are tried in the
order they are added.
.IP "\fB$coercion\->type_constraint\fR" 4
.IX Item "$coercion->type_constraint"
This returns the Moose::Meta::TypeConstraint that was passed to the
constructor.
.IP "\fB$coercion\->has_coercion_for_type($type_name)\fR" 4
.IX Item "$coercion->has_coercion_for_type($type_name)"
Returns true if the coercion can coerce the named type.
.ie n .IP "\fB$coercion\->add_type_coercions( \fB$type_name\fB => \f(BI$sub\fB, ... )\fR" 4
.el .IP "\fB$coercion\->add_type_coercions( \f(CB$type_name\fB => \f(CB$sub\fB, ... )\fR" 4
.IX Item "$coercion->add_type_coercions( $type_name => $sub, ... )"
This method takes a list of type names and subroutine references. If
the coercion already has a mapping for a given type, it throws an
exception.
.Sp
Coercions are actually
.IP "\fB$coercion\->coerce($value)\fR" 4
.IX Item "$coercion->coerce($value)"
This method takes a value and applies the first valid coercion it
finds.
.Sp
This means that if the value could belong to more than type in the
coercion object, the first coercion added is used.
.IP "\fBMoose::Meta::TypeCoercion\->meta\fR" 4
.IX Item "Moose::Meta::TypeCoercion->meta"
This will return a Class::MOP::Class instance for this class.
.SH "BUGS"
.IX Header "BUGS"
All complex software has bugs lurking in it, and this module is no
exception. If you find a bug please either email me, or add the bug
to cpan\-RT.
.SH "AUTHOR"
.IX Header "AUTHOR"
Stevan Little <stevan@iinteractive.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2006\-2009 by Infinity Interactive, Inc.
.PP
<http://www.iinteractive.com>
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
Commit	Line	Data
3fea05b9	1	.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
	2	.\"
	3	.\" Standard preamble:
	4	.\" ========================================================================
	5	.de Sh \" Subsection heading
	6	.br
	7	.if t .Sp
	8	.ne 5
	9	.PP
	10	\fB\\$1\fR
	11	.PP
	12	..
	13	.de Sp \" Vertical space (when we can't use .PP)
	14	.if t .sp .5v
	15	.if n .sp
	16	..
	17	.de Vb \" Begin verbatim text
	18	.ft CW
	19	.nf
	20	.ne \\$1
	21	..
	22	.de Ve \" End verbatim text
	23	.ft R
	24	.fi
	25	..
	26	.\" Set up some character translations and predefined strings. \*(-- will
	27	.\" give an unbreakable dash, \(PI will give pi, \(L" will give a left
	28	.\" double quote, and \*(R" will give a right double quote. \| will give a
	29	.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
	30	.\" do unbreakable dashes and therefore won't be available. \(C` and \(C'
	31	.\" expand to `' in nroff, nothing in troff, for use with C<>.
	32	.tr \(W-\|\(bv\(Tr
	33	.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
	34	.ie n \{\
	35	. ds -- \(*W-
	36	. ds PI pi
	37	. if (\n(.H=4u)&(1m=24u) .ds -- \(W\h'-12u'\(W\h'-12u'-\" diablo 10 pitch
	38	. if (\n(.H=4u)&(1m=20u) .ds -- \(W\h'-12u'\(W\h'-8u'-\" diablo 12 pitch
	39	. ds L" ""
	40	. ds R" ""
	41	. ds C` ""
	42	. ds C' ""
	43	'br\}
	44	.el\{\
	45	. ds -- \\|\(em\\|
	46	. ds PI \(*p
	47	. ds L" ``
	48	. ds R" ''
	49	'br\}
	50	.\"
	51	.\" If the F register is turned on, we'll generate index entries on stderr for
	52	.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
	53	.\" entries marked with X<> in POD. Of course, you'll have to process the
	54	.\" output yourself in some meaningful fashion.
	55	.if \nF \{\
	56	. de IX
	57	. tm Index:\\$1\t\\n%\t"\\$2"
	58	..
	59	. nr % 0
	60	. rr F
	61	.\}
	62	.\"
	63	.\" For nroff, turn off justification. Always turn off hyphenation; it makes
	64	.\" way too many mistakes in technical documents.
65	.hy 0
66	.if n .na
67	.\"
68	.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69	.\" Fear. Run. Save yourself. No user-serviceable parts.
70	. \" fudge factors for nroff and troff
71	.if n \{\
72	. ds #H 0
73	. ds #V .8m
74	. ds #F .3m
75	. ds #[ \f1
76	. ds #] \fP
77	.\}
78	.if t \{\
79	. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80	. ds #V .6m
81	. ds #F 0
82	. ds #[ \&
83	. ds #] \&
84	.\}
85	. \" simple accents for nroff and troff
86	.if n \{\
87	. ds ' \&
88	. ds ` \&
89	. ds ^ \&
90	. ds , \&
91	. ds ~ ~
92	. ds /
93	.\}
94	.if t \{\
95	. ds ' \\k:\h'-(\\n(.wu8/10-\(#H)'\'\h"\|\\n:u"
96	. ds ` \\k:\h'-(\\n(.wu8/10-\(#H)'\`\h'\|\\n:u'
97	. ds ^ \\k:\h'-(\\n(.wu10/11-\(#H)'^\h'\|\\n:u'
98	. ds , \\k:\h'-(\\n(.wu*8/10)',\h'\|\\n:u'
99	. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'\|\\n:u'
100	. ds / \\k:\h'-(\\n(.wu8/10-\(#H)'\z\(sl\h'\|\\n:u'
101	.\}
102	. \" troff and (daisy-wheel) nroff accents
103	.ds : \\k:\h'-(\\n(.wu8/10-\(#H+.1m+\(#F)'\v'-\(#V'\z.\h'.2m+\(#F'.\h'\|\\n:u'\v'\(#V'
104	.ds 8 \h'\(#H'\(b\h'-\*(#H'
105	.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\(#H)/2u'\v'-.3n'\(#[\z\(de\v'.3n'\h'\|\\n:u'\*(#]
106	.ds d- \h'\(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\(#H'
107	.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'\|\\n:u'
108	.ds th \(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u2/3)'\s-1o\s+1\*(#]
109	.ds Th \(#[\s+2I\s-2\h'-\w'I'u3/5'\v'-.3m'o\v'.3m'\*(#]
110	.ds ae a\h'-(\w'a'u*4/10)'e
111	.ds Ae A\h'-(\w'A'u*4/10)'E
112	. \" corrections for vroff
113	.if v .ds ~ \\k:\h'-(\\n(.wu9/10-\(#H)'\s-2\u~\d\s+2\h'\|\\n:u'
114	.if v .ds ^ \\k:\h'-(\\n(.wu10/11-\(#H)'\v'-.4m'^\v'.4m'\h'\|\\n:u'
115	. \" for low resolution devices (crt and lpr)
116	.if \n(.H>23 .if \n(.V>19 \
117	\{\
118	. ds : e
119	. ds 8 ss
120	. ds o a
121	. ds d- d\h'-1'\(ga
122	. ds D- D\h'-1'\(hy
123	. ds th \o'bp'
124	. ds Th \o'LP'
125	. ds ae ae
126	. ds Ae AE
127	.\}
128	.rm #[ #] #H #V #F C
129	.\" ========================================================================
130	.\"
131	.IX Title "Moose::Meta::TypeCoercion 3"
132	.TH Moose::Meta::TypeCoercion 3 "2009-11-19" "perl v5.8.7" "User Contributed Perl Documentation"
133	.SH "NAME"
134	Moose::Meta::TypeCoercion \- The Moose Type Coercion metaclass
135	.SH "DESCRIPTION"
136	.IX Header "DESCRIPTION"
137	A type coercion object is basically a mapping of one or more type
138	constraints and the associated coercions subroutines.
139	.PP
140	It's unlikely that you will need to instantiate an object of this
141	class directly, as it's part of the deep internals of Moose.
142	.SH "METHODS"
143	.IX Header "METHODS"
144	.IP "\fBMoose::Meta::TypeCoercion\->new(%options)\fR" 4
145	.IX Item "Moose::Meta::TypeCoercion->new(%options)"
146	Creates a new type coercion object, based on the options provided.
147	.RS 4
148	.IP "* type_constraint" 8
149	.IX Item "type_constraint"
150	This is the Moose::Meta::TypeConstraint object for the type that is
151	being coerced \fIto\fR.
152	.RE
153	.RS 4
154	.RE
155	.IP "\fB$coercion\->type_coercion_map\fR" 4
156	.IX Item "$coercion->type_coercion_map"
157	This returns the map of type constraints to coercions as an array
158	reference. The values of the array alternate between type names and
159	subroutine references which implement the coercion.
160	.Sp
161	The value is an array reference because coercions are tried in the
162	order they are added.
163	.IP "\fB$coercion\->type_constraint\fR" 4
164	.IX Item "$coercion->type_constraint"
165	This returns the Moose::Meta::TypeConstraint that was passed to the
166	constructor.
167	.IP "\fB$coercion\->has_coercion_for_type($type_name)\fR" 4
168	.IX Item "$coercion->has_coercion_for_type($type_name)"
169	Returns true if the coercion can coerce the named type.
170	.ie n .IP "\fB$coercion\->add_type_coercions( \fB$type_name\fB => \f(BI$sub\fB, ... )\fR" 4
171	.el .IP "\fB$coercion\->add_type_coercions( \f(CB$type_name\fB => \f(CB$sub\fB, ... )\fR" 4
172	.IX Item "$coercion->add_type_coercions( $type_name => $sub, ... )"
173	This method takes a list of type names and subroutine references. If
174	the coercion already has a mapping for a given type, it throws an
175	exception.
176	.Sp
177	Coercions are actually
178	.IP "\fB$coercion\->coerce($value)\fR" 4
179	.IX Item "$coercion->coerce($value)"
180	This method takes a value and applies the first valid coercion it
181	finds.
182	.Sp
183	This means that if the value could belong to more than type in the
184	coercion object, the first coercion added is used.
185	.IP "\fBMoose::Meta::TypeCoercion\->meta\fR" 4
186	.IX Item "Moose::Meta::TypeCoercion->meta"
187	This will return a Class::MOP::Class instance for this class.
188	.SH "BUGS"
189	.IX Header "BUGS"
190	All complex software has bugs lurking in it, and this module is no
191	exception. If you find a bug please either email me, or add the bug
192	to cpan\-RT.
193	.SH "AUTHOR"
194	.IX Header "AUTHOR"
195	Stevan Little <stevan@iinteractive.com>
196	.SH "COPYRIGHT AND LICENSE"
197	.IX Header "COPYRIGHT AND LICENSE"
198	Copyright 2006\-2009 by Infinity Interactive, Inc.
199	.PP
200	<http://www.iinteractive.com>
201	.PP
202	This library is free software; you can redistribute it and/or modify
203	it under the same terms as Perl itself.