Scroll to navigation

Parse::Method::Signatures::Param(3) User Contributed Perl Documentation Parse::Method::Signatures::Param(3)

NAME

Parse::Method::Signatures::Param - a parsed parameter from a signature

ATTRIBUTES

All attributes of this class are read-only.

required

Is this parameter required (true) or optional (false)?

sigil

The effective sigil ('$', '@' or '%') of this parameter.

type_constraints

Type: Parse::Method::Signatures::TypeConstraint

Predicate: has_type_constraints

Representation of the type constraint for this parameter. Most commonly you will just call "meta_type_constraint" and not access this attribute directly.

default_value

Type: Str

Predicate: has_default_value

A string that should be eval'd or injected to get the default value for this parameter. For example:

 $name = 'bar'

Would give a default_value of "'bar'".

constraints

Type: ArrayRef[Str]

Predicate: has_constraints

"where" constraints for this type. Each member of the array a the string (including enclosing braces) of the where constraint block.

param_traits

Type: ArrayRef[ Tupple[Str,Str] ]

Predicate: has_traits

Traits that this parameter is declared to have. For instance

 $foo does coerce

would have a trait of

 ['does', 'coerce']

METHODS

to_string

meta_type_constraint

Get the Moose::Meta::TypeConstraint for this parameter. Check first that the type has a type constraint:

 $tc = $param->meta_type_constraint if $param->has_type_constraints;

SEE ALSO

Parse::Method::Signatures.

AUTHORS

Ash Berlin <ash@cpan.org>.

Florian Ragwitz <rafl@debian.org>.

LICENSE

Licensed under the same terms as Perl itself.

2017-04-10 perl v5.40.0