1 package Moose::Meta::TypeConstraint::Enum;
8 use Moose::Util::TypeConstraints ();
10 use base 'Moose::Meta::TypeConstraint';
12 __PACKAGE__->meta->add_attribute('values' => (
22 my $name = $self->name();
23 $ENUMS{$name} ||= { map { $_ => 1 } @{ $self->values() } };
26 "defined $val && " . '$'
29 . B::perlstring($name)
34 my ( $class, %args ) = @_;
36 $args{parent} = Moose::Util::TypeConstraints::find_type_constraint('Str');
37 $args{inlined} = $inliner;
39 if ( scalar @{ $args{values} } < 2 ) {
41 Moose->throw_error("You must have at least two values to enumerate through");
44 for (@{ $args{values} }) {
47 Moose->throw_error("Enum values must be strings, not undef");
51 Moose->throw_error("Enum values must be strings, not '$_'");
55 my %values = map { $_ => 1 } @{ $args{values} };
56 $args{constraint} = sub { $values{ $_[0] } };
58 my $self = $class->_new(\%args);
60 $self->compile_type_constraint()
61 unless $self->_has_compiled_type_constraint;
67 my ( $self, $type_or_name ) = @_;
69 my $other = Moose::Util::TypeConstraints::find_type_constraint($type_or_name);
71 return unless $other->isa(__PACKAGE__);
73 my @self_values = sort @{ $self->values };
74 my @other_values = sort @{ $other->values };
76 return unless @self_values == @other_values;
78 while ( @self_values ) {
79 my $value = shift @self_values;
80 my $other_value = shift @other_values;
82 return unless $value eq $other_value;
91 my %values = map { $_ => undef } @{ $self->values };
93 return sub { exists $values{$_[0]} };
96 sub _compile_hand_optimized_type_constraint {
99 my %values = map { $_ => undef } @{ $self->values };
101 sub { defined($_[0]) && !ref($_[0]) && exists $values{$_[0]} };
104 sub create_child_type {
105 my ($self, @args) = @_;
106 return Moose::Meta::TypeConstraint->new(@args, parent => $self);
111 # ABSTRACT: Type constraint for enumerated values.
119 This class represents type constraints based on an enumerated list of
124 C<Moose::Meta::TypeConstraint::Enum> is a subclass of
125 L<Moose::Meta::TypeConstraint>.
131 =item B<< Moose::Meta::TypeConstraint::Enum->new(%options) >>
133 This creates a new enum type constraint based on the given
136 It takes the same options as its parent, with several
137 exceptions. First, it requires an additional option, C<values>. This
138 should be an array reference containing a list of valid string
139 values. Second, it automatically sets the parent to the C<Str> type.
141 Finally, it ignores any provided C<constraint> option. The constraint
142 is generated automatically based on the provided C<values>.
144 =item B<< $constraint->values >>
146 Returns the array reference of acceptable values provided to the
149 =item B<< $constraint->create_child_type >>
151 This returns a new L<Moose::Meta::TypeConstraint> object with the type
154 Note that it does I<not> return a C<Moose::Meta::TypeConstraint::Enum>
161 See L<Moose/BUGS> for details on reporting bugs.