Specio::Subs

Section: User Contributed Perl Documentation (3)
Updated: 2021-01-31
Page Index

NAME

Specio::Subs - Make validation and coercion subs from Specio types

VERSION

version 0.47

SYNOPSIS

  use Specio::Subs qw( Specio::Library::Builtins Specio::Library::Perl My::Lib );

  if ( is_PackageName($var) ) { ... }

  assert_Str($var);

  my $person1 = to_Person($var);
  my $person2 = force_Person($var);

DESCRIPTION

This module generates a set of helpful validation and coercion subroutines for all of the types defined in one or more libraries.

To use it, simply import "Specio::Subs" passing a list of one or more library names. This module will load those libraries as needed.

If any of the types in any libraries have names that do not work as part of a Perl subroutine name, this module will throw an exception.

If you have Sub::Util or Sub::Name installed, one of those will be used to name the generated subroutines.

EXPORTS

The following subs are created in the importing package:

is_$type($value)

This subroutine returns a boolean indicating whether or not the $value is valid for the type.

assert_$type($value)

This subroutine dies if the $value is not valid for the type.

to_$type($value)

This subroutine attempts to coerce $value into the given type. If it cannot be coerced it returns the original $value.

This is only created if the type has coercions.

force_$type($value)

This subroutine attempts to coerce $value into the given type, and dies if it cannot do so.

This is only created if the type has coercions.

ADDITIONAL API

This module has a subroutine named "subs_installed_into". It is not exported but it can be called by its fully qualified name. It accepts a single argument, a package name. It returns a list of subs that it generated and installed in the given package, if any.

This exists to make it easy to write a type library that combines other library and generates helper subs for export all at once.

SUPPORT

Bugs may be submitted at <https://github.com/houseabsolute/Specio/issues>.

I am also usually active on IRC as 'autarch' on "irc://irc.perl.org".

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 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.