Specio::Constraint::Enum(3) | User Contributed Perl Documentation | Specio::Constraint::Enum(3) |
NAME
Specio::Constraint::Enum - A class for constraints which require a string matching one of a set of values
VERSION
version 0.49
SYNOPSIS
my $type = Specio::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 Specio::Constraint::Simple, with a few differences:
Specio::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 an arrayref of valid strings for the type.
$enum->values
Returns an array reference of valid values for the type.
ROLES
This class does the Specio::Constraint::Role::Interface and Specio::Role::Inlinable roles.
SUPPORT
Bugs may be submitted at https://github.com/houseabsolute/Specio/issues.
SOURCE
The source code repository for Specio can be found at https://github.com/houseabsolute/Specio.
AUTHOR
Dave Rolsky <autarch@urth.org>
COPYRIGHT AND LICENSE
This software is Copyright (c) 2012 - 2024 by Dave Rolsky.
This is free software, licensed under:
The Artistic License 2.0 (GPL Compatible)
The full text of the license can be found in the LICENSE file included with this distribution.
2025-01-14 | perl v5.40.0 |