Commit | Line | Data |
3fea05b9 |
1 | .\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10) |
2 | .\" |
3 | .\" Standard preamble: |
4 | .\" ======================================================================== |
5 | .de Sp \" Vertical space (when we can't use .PP) |
6 | .if t .sp .5v |
7 | .if n .sp |
8 | .. |
9 | .de Vb \" Begin verbatim text |
10 | .ft CW |
11 | .nf |
12 | .ne \\$1 |
13 | .. |
14 | .de Ve \" End verbatim text |
15 | .ft R |
16 | .fi |
17 | .. |
18 | .\" Set up some character translations and predefined strings. \*(-- will |
19 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
20 | .\" double quote, and \*(R" will give a right double quote. \*(C+ will |
21 | .\" give a nicer C++. Capital omega is used to do unbreakable dashes and |
22 | .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, |
23 | .\" nothing in troff, for use with C<>. |
24 | .tr \(*W- |
25 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
26 | .ie n \{\ |
27 | . ds -- \(*W- |
28 | . ds PI pi |
29 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
30 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
31 | . ds L" "" |
32 | . ds R" "" |
33 | . ds C` "" |
34 | . ds C' "" |
35 | 'br\} |
36 | .el\{\ |
37 | . ds -- \|\(em\| |
38 | . ds PI \(*p |
39 | . ds L" `` |
40 | . ds R" '' |
41 | 'br\} |
42 | .\" |
43 | .\" Escape single quotes in literal strings from groff's Unicode transform. |
44 | .ie \n(.g .ds Aq \(aq |
45 | .el .ds Aq ' |
46 | .\" |
47 | .\" If the F register is turned on, we'll generate index entries on stderr for |
48 | .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
49 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
50 | .\" output yourself in some meaningful fashion. |
51 | .ie \nF \{\ |
52 | . de IX |
53 | . tm Index:\\$1\t\\n%\t"\\$2" |
54 | .. |
55 | . nr % 0 |
56 | . rr F |
57 | .\} |
58 | .el \{\ |
59 | . de IX |
60 | .. |
61 | .\} |
62 | .\" |
63 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
64 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
65 | . \" fudge factors for nroff and troff |
66 | .if n \{\ |
67 | . ds #H 0 |
68 | . ds #V .8m |
69 | . ds #F .3m |
70 | . ds #[ \f1 |
71 | . ds #] \fP |
72 | .\} |
73 | .if t \{\ |
74 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
75 | . ds #V .6m |
76 | . ds #F 0 |
77 | . ds #[ \& |
78 | . ds #] \& |
79 | .\} |
80 | . \" simple accents for nroff and troff |
81 | .if n \{\ |
82 | . ds ' \& |
83 | . ds ` \& |
84 | . ds ^ \& |
85 | . ds , \& |
86 | . ds ~ ~ |
87 | . ds / |
88 | .\} |
89 | .if t \{\ |
90 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
91 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
92 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
93 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
94 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
95 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
96 | .\} |
97 | . \" troff and (daisy-wheel) nroff accents |
98 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
99 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
100 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
101 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
102 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
103 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
104 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
105 | .ds ae a\h'-(\w'a'u*4/10)'e |
106 | .ds Ae A\h'-(\w'A'u*4/10)'E |
107 | . \" corrections for vroff |
108 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
109 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
110 | . \" for low resolution devices (crt and lpr) |
111 | .if \n(.H>23 .if \n(.V>19 \ |
112 | \{\ |
113 | . ds : e |
114 | . ds 8 ss |
115 | . ds o a |
116 | . ds d- d\h'-1'\(ga |
117 | . ds D- D\h'-1'\(hy |
118 | . ds th \o'bp' |
119 | . ds Th \o'LP' |
120 | . ds ae ae |
121 | . ds Ae AE |
122 | .\} |
123 | .rm #[ #] #H #V #F C |
124 | .\" ======================================================================== |
125 | .\" |
126 | .IX Title "Parse::Method::Signatures::Param 3" |
127 | .TH Parse::Method::Signatures::Param 3 "2009-03-15" "perl v5.8.7" "User Contributed Perl Documentation" |
128 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
129 | .\" way too many mistakes in technical documents. |
130 | .if n .ad l |
131 | .nh |
132 | .SH "NAME" |
133 | Parse::Method::Signatures::Param \- a parsed parameter from a signature |
134 | .SH "ATTRIBUTES" |
135 | .IX Header "ATTRIBUTES" |
136 | All attributes of this class are read-only. |
137 | .SS "required" |
138 | .IX Subsection "required" |
139 | Is this parameter required (true) or optional (false)? |
140 | .SS "sigil" |
141 | .IX Subsection "sigil" |
142 | The effective sigil ('$', '@' or '%') of this parameter. |
143 | .SS "type_constraints" |
144 | .IX Subsection "type_constraints" |
145 | .RS 4 |
146 | \&\fBType:\fR Parse::Method::Signatures::TypeConstraint |
147 | .Sp |
148 | \&\fBPredicate:\fR has_type_constraints |
149 | .RE |
150 | .PP |
151 | Representation of the type constraint for this parameter. Most commonly you |
152 | will just call \*(L"meta_type_constraint\*(R" and not access this attribute directly. |
153 | .SS "default_value" |
154 | .IX Subsection "default_value" |
155 | .RS 4 |
156 | \&\fBType:\fR Str |
157 | .Sp |
158 | \&\fBPredicate:\fR has_default_value |
159 | .RE |
160 | .PP |
161 | A string that should be eval'd or injected to get the default value for this |
162 | parameter. For example: |
163 | .PP |
164 | .Vb 1 |
165 | \& $name = \*(Aqbar\*(Aq |
166 | .Ve |
167 | .PP |
168 | Would give a default_value of \*(L"'bar'\*(R". |
169 | .SS "constraints" |
170 | .IX Subsection "constraints" |
171 | .RS 4 |
172 | \&\fBType:\fR ArrayRef[Str] |
173 | .Sp |
174 | \&\fBPredicate:\fR has_constraints |
175 | .RE |
176 | .PP |
177 | \&\f(CW\*(C`where\*(C'\fR constraints for this type. Each member of the array a the string |
178 | (including enclosing braces) of the where constraint block. |
179 | .SS "param_traits" |
180 | .IX Subsection "param_traits" |
181 | .RS 4 |
182 | \&\fBType:\fR ArrayRef[ Tupple[Str,Str] ] |
183 | .Sp |
184 | \&\fBPredicate:\fR has_traits |
185 | .RE |
186 | .PP |
187 | Traits that this parameter is declared to have. For instance |
188 | .PP |
189 | .Vb 1 |
190 | \& $foo does coerce |
191 | .Ve |
192 | .PP |
193 | would have a trait of |
194 | .PP |
195 | .Vb 1 |
196 | \& [\*(Aqdoes\*(Aq, \*(Aqcoerce\*(Aq] |
197 | .Ve |
198 | .SH "METHODS" |
199 | .IX Header "METHODS" |
200 | .SS "to_string" |
201 | .IX Subsection "to_string" |
202 | .SS "meta_type_constraint" |
203 | .IX Subsection "meta_type_constraint" |
204 | Get the Moose::Meta::TypeConstraint for this parameter. Check first that the |
205 | type has a type constraint: |
206 | .PP |
207 | .Vb 1 |
208 | \& $tc = $param\->meta_type_constraint if $param\->has_type_constraints; |
209 | .Ve |
210 | .SH "SEE ALSO" |
211 | .IX Header "SEE ALSO" |
212 | Parse::Method::Signatures. |
213 | .SH "AUTHORS" |
214 | .IX Header "AUTHORS" |
215 | Ash Berlin <ash@cpan.org>. |
216 | .PP |
217 | Florian Ragwitz <rafl@debian.org>. |
218 | .SH "LICENSE" |
219 | .IX Header "LICENSE" |
220 | Licensed under the same terms as Perl itself. |