Dave Rolsky > Type-0.05-TRIAL > Type::Constraint::Enum

Download:
Type-0.05-TRIAL.tar.gz

Dependencies

Annotate this POD

Module Version: 0.05   Source  

NAME ^

Type::Constraint::Enum - A class for constraints which require a string matching one of a set of values

VERSION ^

version 0.05

SYNOPSIS ^

  my $type = Type::Constraint::Enum->new(...);
  print $_, "\n" for @{ $type->values() };

DESCRIPTION ^

This is a specialized type constraint class for types which require a string that matches one of a list of values.

API ^

This class provides all of the same methods as Type::Constraint::Simple, with a few differences:

Type::Constraint::Enum->new( ... )

The parent parameter is ignored if it passed, as it is always set to the Str type.

The inline_generator and constraint parameters are also ignored. This class provides its own default inline generator subroutine reference.

Finally, this class requires an additional parameter, values. This must be a a list of valid strings for the type.

$enum->values()

Returns an array reference of valid values for the type.

ROLES ^

This class does the Type::Constraint::Role::Interface, Type::Role::Inlinable, and MooseX::Clone roles.

AUTHOR ^

Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE ^

This software is Copyright (c) 2012 by Dave Rolsky.

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)
syntax highlighting: