/usr/share/perl5/Type/Utils.pm is in libtype-tiny-perl 1.000005-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 | package Type::Utils;
use 5.006001;
use strict;
use warnings;
BEGIN {
$Type::Utils::AUTHORITY = 'cpan:TOBYINK';
$Type::Utils::VERSION = '1.000005';
}
sub _croak ($;@) { require Error::TypeTiny; goto \&Error::TypeTiny::croak }
use Scalar::Util qw< blessed >;
use Type::Library;
use Type::Tiny;
use Types::TypeTiny qw< TypeTiny to_TypeTiny HashLike StringLike CodeLike >;
our @EXPORT = qw<
declare as where message inline_as
class_type role_type duck_type union intersection enum
coerce from via
declare_coercion to_type
>;
our @EXPORT_OK = (
@EXPORT,
qw<
extends type subtype
match_on_type compile_match_on_type
dwim_type english_list
classifier
>,
);
require Exporter::Tiny;
our @ISA = 'Exporter::Tiny';
sub extends
{
_croak "Not a type library" unless caller->isa("Type::Library");
my $caller = caller->meta;
foreach my $lib (@_)
{
eval "use $lib; 1" or _croak "Could not load library '$lib': $@";
if ($lib->isa("Type::Library") or $lib eq 'Types::TypeTiny')
{
$caller->add_type( $lib->get_type($_) )
for sort $lib->meta->type_names;
$caller->add_coercion( $lib->get_coercion($_) )
for sort $lib->meta->coercion_names;
}
elsif ($lib->isa('MooseX::Types::Base'))
{
require Moose::Util::TypeConstraints;
my $types = $lib->type_storage;
for my $name (sort keys %$types)
{
my $moose = Moose::Util::TypeConstraints::find_type_constraint($types->{$name});
my $tt = Types::TypeTiny::to_TypeTiny($moose);
$caller->add_type(
$tt->create_child_type(library => $caller, name => $name, coercion => $moose->has_coercion ? 1 : 0)
);
}
}
elsif ($lib->isa('MouseX::Types::Base'))
{
require Mouse::Util::TypeConstraints;
my $types = $lib->type_storage;
for my $name (sort keys %$types)
{
my $mouse = Mouse::Util::TypeConstraints::find_type_constraint($types->{$name});
my $tt = Types::TypeTiny::to_TypeTiny($mouse);
$caller->add_type(
$tt->create_child_type(library => $caller, name => $name, coercion => $mouse->has_coercion ? 1 : 0)
);
}
}
else
{
_croak("'$lib' is not a type constraint library");
}
}
}
sub declare
{
my %opts;
if (@_ % 2 == 0)
{
%opts = @_;
if (@_==2 and $_[0]=~ /^_*[A-Z]/ and $_[1] =~ /^[0-9]+$/)
{
require Carp;
Carp::carp("Possible missing comma after 'declare $_[0]'");
}
}
else
{
(my($name), %opts) = @_;
_croak "Cannot provide two names for type" if exists $opts{name};
$opts{name} = $name;
}
my $caller = caller($opts{_caller_level} || 0);
$opts{library} = $caller;
if (defined $opts{parent})
{
$opts{parent} = to_TypeTiny($opts{parent});
unless (TypeTiny->check($opts{parent}))
{
$caller->isa("Type::Library")
or _croak("Parent type cannot be a %s", ref($opts{parent})||'non-reference scalar');
$opts{parent} = $caller->meta->get_type($opts{parent})
or _croak("Could not find parent type");
}
}
my $type;
if (defined $opts{parent})
{
$type = delete($opts{parent})->create_child_type(%opts);
}
else
{
my $bless = delete($opts{bless}) || "Type::Tiny";
eval "require $bless";
$type = $bless->new(%opts);
}
if ($caller->isa("Type::Library"))
{
$caller->meta->add_type($type) unless $type->is_anon;
}
return $type;
}
*subtype = \&declare;
*type = \&declare;
sub as (@)
{
parent => @_;
}
sub where (&;@)
{
constraint => @_;
}
sub message (&;@)
{
message => @_;
}
sub inline_as (&;@)
{
inlined => @_;
}
sub class_type
{
my $name = ref($_[0]) ? undef : shift;
my %opts = %{ shift or {} };
if (defined $name)
{
$opts{name} = $name unless exists $opts{name};
$opts{class} = $name unless exists $opts{class};
$opts{name} =~ s/:://g;
}
$opts{bless} = "Type::Tiny::Class";
{ no warnings "numeric"; $opts{_caller_level}++ }
declare(%opts);
}
sub role_type
{
my $name = ref($_[0]) ? undef : shift;
my %opts = %{ shift or {} };
if (defined $name)
{
$opts{name} = $name unless exists $opts{name};
$opts{role} = $name unless exists $opts{role};
$opts{name} =~ s/:://g;
}
$opts{bless} = "Type::Tiny::Role";
{ no warnings "numeric"; $opts{_caller_level}++ }
declare(%opts);
}
sub duck_type
{
my $name = ref($_[0]) ? undef : shift;
my @methods = @{ shift or [] };
my %opts;
$opts{name} = $name if defined $name;
$opts{methods} = \@methods;
$opts{bless} = "Type::Tiny::Duck";
{ no warnings "numeric"; $opts{_caller_level}++ }
declare(%opts);
}
sub enum
{
my $name = ref($_[0]) ? undef : shift;
my @values = @{ shift or [] };
my %opts;
$opts{name} = $name if defined $name;
$opts{values} = \@values;
$opts{bless} = "Type::Tiny::Enum";
{ no warnings "numeric"; $opts{_caller_level}++ }
declare(%opts);
}
sub union
{
my $name = ref($_[0]) ? undef : shift;
my @tcs = @{ shift or [] };
my %opts;
$opts{name} = $name if defined $name;
$opts{type_constraints} = \@tcs;
$opts{bless} = "Type::Tiny::Union";
{ no warnings "numeric"; $opts{_caller_level}++ }
declare(%opts);
}
sub intersection
{
my $name = ref($_[0]) ? undef : shift;
my @tcs = @{ shift or [] };
my %opts;
$opts{name} = $name if defined $name;
$opts{type_constraints} = \@tcs;
$opts{bless} = "Type::Tiny::Intersection";
{ no warnings "numeric"; $opts{_caller_level}++ }
declare(%opts);
}
sub declare_coercion
{
my %opts;
$opts{name} = shift if !ref($_[0]);
while (HashLike->check($_[0]) and not TypeTiny->check($_[0]))
{
%opts = (%opts, %{+shift});
}
my $caller = caller($opts{_caller_level} || 0);
$opts{library} = $caller;
my $bless = delete($opts{bless}) || "Type::Coercion";
eval "require $bless";
my $c = $bless->new(%opts);
my @C;
if ($caller->isa("Type::Library"))
{
my $meta = $caller->meta;
$meta->add_coercion($c) unless $c->is_anon;
while (@_)
{
push @C, map { ref($_) ? to_TypeTiny($_) : $meta->get_type($_)||$_ } shift;
push @C, shift;
}
}
else
{
@C = @_;
}
$c->add_type_coercions(@C);
return $c->freeze;
}
sub coerce
{
if ((scalar caller)->isa("Type::Library"))
{
my $meta = (scalar caller)->meta;
my ($type) = map { ref($_) ? to_TypeTiny($_) : $meta->get_type($_)||$_ } shift;
my @opts;
while (@_)
{
push @opts, map { ref($_) ? to_TypeTiny($_) : $meta->get_type($_)||$_ } shift;
push @opts, shift;
}
return $type->coercion->add_type_coercions(@opts);
}
my ($type, @opts) = @_;
$type = to_TypeTiny($type);
return $type->coercion->add_type_coercions(@opts);
}
sub from (@)
{
return @_;
}
sub to_type (@)
{
my $type = shift;
unless (TypeTiny->check($type))
{
caller->isa("Type::Library")
or _croak "Target type cannot be a string";
$type = caller->meta->get_type($type)
or _croak "Could not find target type";
}
return +{ type_constraint => $type }, @_;
}
sub via (&;@)
{
return @_;
}
sub match_on_type
{
my $value = shift;
while (@_)
{
my $code;
if (@_ == 1)
{
$code = shift;
}
else
{
(my($type), $code) = splice(@_, 0, 2);
TypeTiny->($type)->check($value) or next;
}
if (StringLike->check($code))
{
local $_ = $value;
if (wantarray) {
my @r = eval "$code";
die $@ if $@;
return @r;
}
if (defined wantarray) {
my $r = eval "$code";
die $@ if $@;
return $r;
}
eval "$code";
die $@ if $@;
return;
}
else
{
CodeLike->($code);
local $_ = $value;
return $code->($value);
}
}
_croak("No cases matched for %s", Type::Tiny::_dd($value));
}
sub compile_match_on_type
{
my @code = 'sub { local $_ = $_[0]; ';
my @checks;
my @actions;
my $els = '';
while (@_)
{
my ($type, $code);
if (@_ == 1)
{
require Types::Standard;
($type, $code) = (Types::Standard::Any(), shift);
}
else
{
($type, $code) = splice(@_, 0, 2);
TypeTiny->($type);
}
if ($type->can_be_inlined)
{
push @code, sprintf('%sif (%s)', $els, $type->inline_check('$_'));
}
else
{
push @checks, $type;
push @code, sprintf('%sif ($checks[%d]->check($_))', $els, $#checks);
}
$els = 'els';
if (StringLike->check($code))
{
push @code, sprintf(' { %s }', $code);
}
else
{
CodeLike->($code);
push @actions, $code;
push @code, sprintf(' { $actions[%d]->(@_) }', $#actions);
}
}
push @code, 'else', ' { Type::Utils::_croak("No cases matched for %s", Type::Tiny::_dd($_[0])) }';
push @code, '}'; # /sub
require Eval::TypeTiny;
return Eval::TypeTiny::eval_closure(
source => \@code,
environment => {
'@actions' => \@actions,
'@checks' => \@checks,
},
);
}
sub classifier
{
my $i;
compile_match_on_type(
+(
map {
my $type = $_->[0];
$type => sub { $type };
}
sort { $b->[1] <=> $a->[1] or $a->[2] <=> $b->[2] }
map [$_, scalar(my @parents = $_->parents), ++$i],
@_
),
q[ undef ],
);
}
{
package #hide
Type::Registry::DWIM;
our @ISA = qw(Type::Registry);
sub foreign_lookup
{
my $self = shift;
my $r = $self->SUPER::foreign_lookup(@_);
return $r if $r;
if (defined($self->{"~~assume"})
and $_[0] =~ /[A-Z_a-z][0-9A-Z_a-z]*(?:::[0-9A-Z_a-z]+)*/)
{
my $method = $self->{"~~assume"};
return $self->$method(@_);
}
return;
}
sub simple_lookup
{
my $self = shift;
my $r;
# If the lookup is chained to a class, then the class' own
# type registry gets first refusal.
#
if (defined $self->{"~~chained"})
{
my $chained = "Type::Registry"->for_class($self->{"~~chained"});
$r = eval { $chained->simple_lookup(@_) } unless $self == $chained;
return $r if defined $r;
}
# Fall back to types in Types::Standard.
require Types::Standard;
return 'Types::Standard'->get_type($_[0]) if 'Types::Standard'->has_type($_[0]);
# Only continue any further if we've been called from Type::Parser.
return unless $_[1];
my $moose_lookup = sub
{
if ($INC{'Moose.pm'})
{
require Moose::Util::TypeConstraints;
require Types::TypeTiny;
$r = Moose::Util::TypeConstraints::find_type_constraint($_[0]);
$r = Types::TypeTiny::to_TypeTiny($r) if defined $r;
}
defined $r;
};
my $mouse_lookup = sub
{
if ($INC{'Mouse.pm'})
{
require Mouse::Util::TypeConstraints;
require Types::TypeTiny;
$r = Mouse::Util::TypeConstraints::find_type_constraint($_[0]);
$r = Types::TypeTiny::to_TypeTiny($r) if defined $r;
}
defined $r;
};
my $meta;
if (defined $self->{"~~chained"})
{
$meta ||= Moose::Util::find_meta($self->{"~~chained"}) if $INC{'Moose.pm'};
$meta ||= Mouse::Util::find_meta($self->{"~~chained"}) if $INC{'Mouse.pm'};
}
if ($meta and $meta->isa('Class::MOP::Module'))
{
$moose_lookup->(@_) and return $r;
}
elsif ($meta and $meta->isa('Mouse::Meta::Module'))
{
$mouse_lookup->(@_) and return $r;
}
else
{
$moose_lookup->(@_) and return $r;
$mouse_lookup->(@_) and return $r;
}
return $self->foreign_lookup(@_);
}
}
our $dwimmer;
sub dwim_type
{
my ($string, %opts) = @_;
$opts{for} = caller unless defined $opts{for};
$dwimmer ||= do {
require Type::Registry;
'Type::Registry::DWIM'->new;
};
local $dwimmer->{'~~chained'} = $opts{for};
local $dwimmer->{'~~assume'} = $opts{does} ? 'make_role_type' : 'make_class_type';
$dwimmer->lookup($string);
}
sub english_list
{
my $conjunction = ref($_[0]) eq 'SCALAR' ? ${+shift} : 'and';
my @items = sort @_;
return $items[0] if @items == 1;
return "$items[0] $conjunction $items[1]" if @items == 2;
my $tail = pop @items;
join(', ', @items, "$conjunction $tail");
}
1;
__END__
=pod
=encoding utf-8
=for stopwords smush smushed
=head1 NAME
Type::Utils - utility functions to make defining and using type constraints a little easier
=head1 SYNOPSIS
package Types::Mine;
use Type::Library -base;
use Type::Utils -all;
BEGIN { extends "Types::Standard" };
declare "AllCaps",
as "Str",
where { uc($_) eq $_ },
inline_as { my $varname = $_[1]; "uc($varname) eq $varname" };
coerce "AllCaps",
from "Str", via { uc($_) };
=head1 STATUS
This module is covered by the
L<Type-Tiny stability policy|Type::Tiny::Manual::Policies/"STABILITY">.
=head1 DESCRIPTION
This module provides utility functions to make defining and using type
constraints a little easier.
=head2 Type declaration functions
Many of the following are similar to the similarly named functions described
in L<Moose::Util::TypeConstraints>.
=over
=item C<< declare $name, %options >>
=item C<< declare %options >>
Declare a named or anonymous type constraint. Use C<as> and C<where> to
specify the parent type (if any) and (possibly) refine its definition.
declare EvenInt, as Int, where { $_ % 2 == 0 };
my $EvenInt = declare as Int, where { $_ % 2 == 0 };
B<< NOTE: >>
If the caller package inherits from L<Type::Library> then any non-anonymous
types declared in the package will be automatically installed into the
library.
Hidden gem: if you're inheriting from a type constraint that includes some
coercions, you can include C<< coercion => 1 >> in the C<< %options >> hash
to inherit the coercions.
=item C<< subtype $name, %options >>
=item C<< subtype %options >>
Declare a named or anonymous type constraint which is descended from an
existing type constraint. Use C<as> and C<where> to specify the parent
type and refine its definition.
Actually, you should use C<declare> instead; this is just an alias.
This function is not exported by default.
=item C<< type $name, %options >>
=item C<< type %options >>
Declare a named or anonymous type constraint which is not descended from
an existing type constraint. Use C<where> to provide a coderef that
constrains values.
Actually, you should use C<declare> instead; this is just an alias.
This function is not exported by default.
=item C<< as $parent >>
Used with C<declare> to specify a parent type constraint:
declare EvenInt, as Int, where { $_ % 2 == 0 };
=item C<< where { BLOCK } >>
Used with C<declare> to provide the constraint coderef:
declare EvenInt, as Int, where { $_ % 2 == 0 };
The coderef operates on C<< $_ >>, which is the value being tested.
=item C<< message { BLOCK } >>
Generate a custom error message when a value fails validation.
declare EvenInt,
as Int,
where { $_ % 2 == 0 },
message {
Int->validate($_) or "$_ is not divisible by two";
};
Without a custom message, the messages generated by Type::Tiny are along
the lines of I<< Value "33" did not pass type constraint "EvenInt" >>,
which is usually reasonable.
=item C<< inline_as { BLOCK } >>
Generate a string of Perl code that can be used to inline the type check into
other functions. If your type check is being used within a L<Moose> or L<Moo>
constructor or accessor methods, or used by L<Type::Params>, this can lead to
significant performance improvements.
declare EvenInt,
as Int,
where { $_ % 2 == 0 },
inline_as {
my ($constraint, $varname) = @_;
my $perlcode =
$constraint->parent->inline_check($varname)
. "&& ($varname % 2 == 0)";
return $perlcode;
};
warn EvenInt->inline_check('$xxx'); # demonstration
B<Experimental:> your C<inline_as> block can return a list, in which case
these will be smushed together with "&&". The first item on the list may
be undef, in which case the undef will be replaced by the inlined parent
type constraint. (And will throw an exception if there is no parent.)
declare EvenInt,
as Int,
where { $_ % 2 == 0 },
inline_as {
return (undef, "($_ % 2 == 0)");
};
Returning a list like this is considered experimental, is not tested very
much, and I offer no guarantees that it will necessarily work with
Moose/Mouse/Moo.
=item C<< class_type $name, { class => $package, %options } >>
=item C<< class_type { class => $package, %options } >>
=item C<< class_type $name >>
Shortcut for declaring a L<Type::Tiny::Class> type constraint.
If C<< $package >> is omitted, is assumed to be the same as C<< $name >>.
If C<< $name >> contains "::" (which would be an invalid name as far as
L<Type::Tiny> is concerned), this will be removed.
So for example, C<< class_type("Foo::Bar") >> declares a L<Type::Tiny::Class>
type constraint named "FooBar" which constrains values to objects blessed
into the "Foo::Bar" package.
=item C<< role_type $name, { role => $package, %options } >>
=item C<< role_type { role => $package, %options } >>
=item C<< role_type $name >>
Shortcut for declaring a L<Type::Tiny::Role> type constraint.
If C<< $package >> is omitted, is assumed to be the same as C<< $name >>.
If C<< $name >> contains "::" (which would be an invalid name as far as
L<Type::Tiny> is concerned), this will be removed.
=item C<< duck_type $name, \@methods >>
=item C<< duck_type \@methods >>
Shortcut for declaring a L<Type::Tiny::Duck> type constraint.
=item C<< union $name, \@constraints >>
=item C<< union \@constraints >>
Shortcut for declaring a L<Type::Tiny::Union> type constraint.
=item C<< enum $name, \@values >>
=item C<< enum \@values >>
Shortcut for declaring a L<Type::Tiny::Enum> type constraint.
=item C<< intersection $name, \@constraints >>
=item C<< intersection \@constraints >>
Shortcut for declaring a L<Type::Tiny::Intersection> type constraint.
=back
=head2 Coercion declaration functions
Many of the following are similar to the similarly named functions described
in L<Moose::Util::TypeConstraints>.
=over
=item C<< coerce $target, @coercions >>
Add coercions to the target type constraint. The list of coercions is a
list of type constraint, conversion code pairs. Conversion code can be
either a string of Perl code or a coderef; in either case the value to
be converted is C<< $_ >>.
=item C<< from $source >>
Sugar to specify a type constraint in a list of coercions:
coerce EvenInt, from Int, via { $_ * 2 }; # As a coderef...
coerce EvenInt, from Int, q { $_ * 2 }; # or as a string!
=item C<< via { BLOCK } >>
Sugar to specify a coderef in a list of coercions.
=item C<< declare_coercion $name, \%opts, $type1, $code1, ... >>
=item C<< declare_coercion \%opts, $type1, $code1, ... >>
Declares a coercion that is not explicitly attached to any type in the
library. For example:
declare_coercion "ArrayRefFromAny", from "Any", via { [$_] };
This coercion will be exportable from the library as a L<Type::Coercion>
object, but the ArrayRef type exported by the library won't automatically
use it.
Coercions declared this way are immutable (frozen).
=item C<< to_type $type >>
Used with C<declare_coercion> to declare the target type constraint for
a coercion, but still without explicitly attaching the coercion to the
type constraint:
declare_coercion "ArrayRefFromAny",
to_type "ArrayRef",
from "Any", via { [$_] };
You should pretty much always use this when declaring an unattached
coercion because it's exceedingly useful for a type coercion to know what
it will coerce to - this allows it to skip coercion when no coercion is
needed (e.g. avoiding coercing C<< [] >> to C<< [ [] ] >>) and allows
C<assert_coerce> to work properly.
=back
=head2 Type library management
=over
=item C<< extends @libraries >>
Indicates that this type library extends other type libraries, importing
their type constraints.
Should usually be executed in a C<< BEGIN >> block.
This is not exported by default because it's not fun to export it to Moo,
Moose or Mouse classes! C<< use Type::Utils -all >> can be used to import
it into your type library.
=back
=head2 Other
=over
=item C<< match_on_type $value => ($type => \&action, ..., \&default?) >>
Something like a C<switch>/C<case> or C<given>/C<when> construct. Dispatches
along different code paths depending on the type of the incoming value.
Example blatantly stolen from the Moose documentation:
sub to_json
{
my $value = shift;
return match_on_type $value => (
HashRef() => sub {
my $hash = shift;
'{ '
. (
join ", " =>
map { '"' . $_ . '" : ' . to_json( $hash->{$_} ) }
sort keys %$hash
) . ' }';
},
ArrayRef() => sub {
my $array = shift;
'[ '.( join ", " => map { to_json($_) } @$array ).' ]';
},
Num() => q {$_},
Str() => q { '"' . $_ . '"' },
Undef() => q {'null'},
=> sub { die "$_ is not acceptable json type" },
);
}
Note that unlike Moose, code can be specified as a string instead of a
coderef. (e.g. for C<Num>, C<Str> and C<Undef> above.)
For improved performance, try C<compile_match_on_type>.
This function is not exported by default.
=item C<< my $coderef = compile_match_on_type($type => \&action, ..., \&default?) >>
Compile a C<match_on_type> block into a coderef. The following JSON
converter is about two orders of magnitude faster than the previous
example:
sub to_json;
*to_json = compile_match_on_type(
HashRef() => sub {
my $hash = shift;
'{ '
. (
join ", " =>
map { '"' . $_ . '" : ' . to_json( $hash->{$_} ) }
sort keys %$hash
) . ' }';
},
ArrayRef() => sub {
my $array = shift;
'[ '.( join ", " => map { to_json($_) } @$array ).' ]';
},
Num() => q {$_},
Str() => q { '"' . $_ . '"' },
Undef() => q {'null'},
=> sub { die "$_ is not acceptable json type" },
);
Remember to store the coderef somewhere fairly permanent so that you
don't compile it over and over. C<state> variables (in Perl >= 5.10)
are good for this. (Same sort of idea as L<Type::Params>.)
This function is not exported by default.
=item C<< my $coderef = classifier(@types) >>
Returns a coderef that can be used to classify values according to their
type constraint. The coderef, when passed a value, returns a type
constraint which the value satisfies.
use feature qw( say );
use Type::Utils qw( classifier );
use Types::Standard qw( Int Num Str Any );
my $classifier = classifier(Str, Int, Num, Any);
say $classifier->( "42" )->name; # Int
say $classifier->( "4.2" )->name; # Num
say $classifier->( [] )->name; # Any
Note that, for example, "42" satisfies Int, but it would satisfy the
type constraints Num, Str, and Any as well. In this case, the
classifier has picked the most specific type constraint that "42"
satisfies.
If no type constraint is satisfied by the value, then the classifier
will return undef.
=item C<< dwim_type($string, %options) >>
Given a string like "ArrayRef[Int|CodeRef]", turns it into a type constraint
object, hopefully doing what you mean.
It uses the syntax of L<Type::Parser>. Firstly the L<Type::Registry>
for the caller package is consulted; if that doesn't have a match,
L<Types::Standard> is consulted for type constraint names; and if
there's still no match, then if a type constraint looks like a class
name, a new L<Type::Tiny::Class> object is created for it.
Somewhere along the way, it also checks Moose/Mouse's type constraint
registries if they are loaded.
You can specify an alternative for the caller using the C<for> option.
If you'd rather create a L<Type::Tiny::Role> object, set the C<does>
option to true.
# An arrayref of objects, each of which must do role Foo.
my $type = dwim_type("ArrayRef[Foo]", does => 1);
Type::Registry->for_me->add_types("-Standard");
Type::Registry->for_me->alias_type("Int" => "Foo");
# An arrayref of integers.
my $type = dwim_type("ArrayRef[Foo]", does => 1);
While it's probably better overall to use the proper L<Type::Registry>
interface for resolving type constraint strings, this function often does
what you want.
It should never die if it fails to find a type constraint (but may die
if the type constraint string is syntactically malformed), preferring to
return undef.
This function is not exported by default.
=item C<< english_list(\$conjunction, @items) >>
Joins the items with commas, placing a conjunction before the final item.
The conjunction is optional, defaulting to "and".
english_list(qw/foo bar baz/); # "foo, bar, and baz"
english_list(\"or", qw/quux quuux/); # "quux or quuux"
This function is not exported by default.
=back
=head1 EXPORT
By default, all of the functions documented above are exported, except
C<subtype> and C<type> (prefer C<declare> instead), C<extends>, C<dwim_type>,
C<match_on_type>/C<compile_match_on_type>, C<classifier>, and
C<english_list>.
This module uses L<Exporter::Tiny>; see the documentation of that module
for tips and tricks importing from Type::Utils.
=head1 BUGS
Please report any bugs to
L<http://rt.cpan.org/Dist/Display.html?Queue=Type-Tiny>.
=head1 SEE ALSO
L<Type::Tiny::Manual>.
L<Type::Tiny>, L<Type::Library>, L<Types::Standard>, L<Type::Coercion>.
L<Type::Tiny::Class>, L<Type::Tiny::Role>, L<Type::Tiny::Duck>,
L<Type::Tiny::Enum>, L<Type::Tiny::Union>.
L<Moose::Util::TypeConstraints>,
L<Mouse::Util::TypeConstraints>.
=head1 AUTHOR
Toby Inkster E<lt>tobyink@cpan.orgE<gt>.
=head1 COPYRIGHT AND LICENCE
This software is copyright (c) 2013-2014 by Toby Inkster.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=head1 DISCLAIMER OF WARRANTIES
THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
|