Current File : /home/opti/perl/usr/man/man3/Type::Tiny::Manual::UsingWithMoose.3pm
.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
. if \nF \{
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Type::Tiny::Manual::UsingWithMoose 3"
.TH Type::Tiny::Manual::UsingWithMoose 3 "2018-07-29" "perl v5.16.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Type::Tiny::Manual::UsingWithMoose \- how to use Type::Tiny and Type::Library with Moose
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& {
\& package Person;
\&
\& use Moose;
\& use Types::Standard qw( Str Int );
\&
\& has name => (
\& is => "ro",
\& isa => Str,
\& );
\&
\& my $PositiveInt = Int
\& \-> where( sub { $_ > 0 } )
\& \-> plus_coercions( Int, sub { abs $_ } );
\&
\& has age => (
\& is => "ro",
\& isa => $PositiveInt,
\& coerce => 1,
\& writer => "_set_age",
\& );
\&
\& sub get_older {
\& my $self = shift;
\& my ($years) = @_;
\& $PositiveInt\->assert_valid($years);
\& $self\->_set_age($self\->age + $years);
\& }
\& }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Type::Tiny is tested with Moose 2.0007 and above.
.PP
Type::Tiny type constraints have an \s-1API\s0 almost identical to that of
Moose::Meta::TypeConstraint. It is also able to build a
Moose::Meta::TypeConstraint constraint from a Type::Tiny constraint, and
will do so automatically when needed. When Moose.pm is loaded, Type::Tiny
will use Perl's \f(CW\*(C`AUTOLOAD\*(C'\fR feature to proxy method calls through to the
Moose::Meta::TypeConstraint object. In short, you can use a Type::Tiny
object pretty much anywhere you'd use a Moose::Meta::TypeConstraint and
you are unlikely to notice the difference.
.SS "Per-Attribute Coercions"
.IX Subsection "Per-Attribute Coercions"
Type::Tiny offers convenience methods to alter the list of coercions
associated with a type constraint. Let's imagine we wish to allow our
\&\f(CW\*(C`name\*(C'\fR attribute to be coerced from an arrayref of strings.
.PP
.Vb 7
\& has name => (
\& is => "ro",
\& isa => Str\->plus_coercions(
\& ArrayRef[Str], sub { join " ", @{$_} },
\& ),
\& coerce => 1,
\& );
.Ve
.PP
This coercion will apply to the \f(CW\*(C`name\*(C'\fR attribute only; other attributes
using the \f(CW\*(C`Str\*(C'\fR type constraint will be unaffected.
.PP
See the documentation for \f(CW\*(C`plus_coercions\*(C'\fR, \f(CW\*(C`minus_coercions\*(C'\fR and
\&\f(CW\*(C`no_coercions\*(C'\fR in Type::Tiny.
.SS "Optimization"
.IX Subsection "Optimization"
The usual advice for optimizing type constraints applies: use type constraints
which can be inlined whenever possible.
.PP
Defining coercions as strings rather than coderefs won't give you as much of
a boost with Moose as it does with Moo, because Moose doesn't inline coercion
code. However, it should still improve performance somewhat because it allows
Type::Coercion to do some internal inlining.
.PP
See also Type::Tiny::Manual::Optimization.
.SS "Interactions with MooseX-Types"
.IX Subsection "Interactions with MooseX-Types"
Type::Tiny and MooseX::Types type constraints should \*(L"play nice\*(R". If, for
example, \f(CW\*(C`ArrayRef\*(C'\fR is taken from Types::Standard (i.e. a Type::Tiny\-based
type library), and \f(CW\*(C`PositiveInt\*(C'\fR is taken from MooseX::Types::Common::Numeric,
then the following should \*(L"just work\*(R":
.PP
.Vb 1
\& isa => ArrayRef[ PositiveInt ]
\&
\& isa => PositiveInt | ArrayRef
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
For examples using Type::Tiny with Moose see the \s-1SYNOPSIS\s0 sections of
Type::Tiny and Type::Library, and the
Moose integration tests <https://github.com/tobyink/p5-type-tiny/tree/master/t/30-integration/Moose>,
and
MooseX-Types integration tests <https://github.com/tobyink/p5-type-tiny/tree/master/t/30-integration/MooseX-Types>
in the test suite.
.SH "AUTHOR"
.IX Header "AUTHOR"
Toby Inkster <tobyink@cpan.org>.
.SH "COPYRIGHT AND LICENCE"
.IX Header "COPYRIGHT AND LICENCE"
This software is copyright (c) 2013\-2014, 2017\-2018 by Toby Inkster.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
.SH "DISCLAIMER OF WARRANTIES"
.IX Header "DISCLAIMER OF WARRANTIES"
\&\s-1THIS PACKAGE IS PROVIDED \*(L"AS IS\*(R" AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.\s0
Mini Shell