.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" 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 >0, 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
.\" ========================================================================
.\"
.IX Title "Type::Tiny::Manual::UsingWithMouse 3"
.TH Type::Tiny::Manual::UsingWithMouse 3 "2021-07-31" "perl v5.26.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::UsingWithMouse \- how to use Type::Tiny with Mouse
.SH "MANUAL"
.IX Header "MANUAL"
First read Type::Tiny::Manual::Moo, Type::Tiny::Manual::Moo2, and
Type::Tiny::Manual::Moo3. Everything in those parts of the manual
should work exactly the same in Mouse.
.PP
This part of the manual will focus on Mouse-specifics.
.PP
Overall, Type::Tiny is less well-tested with Mouse than it is with
Moose and Moo, but there are still a good number of test cases for
using Type::Tiny with Mouse, and there are no known major issues
with Type::Tiny's Mouse support.
.SS "Why Use Type::Tiny At All?"
.IX Subsection "Why Use Type::Tiny At All?"
Mouse does have a built-in type constraint system which is fairly
convenient to use, but there are several reasons you should consider
using Type::Tiny instead.
.IP "\(bu" 4
Type::Tiny provides helpful methods like \f(CW\*(C`where\*(C'\fR and \f(CW\*(C`plus_coercions\*(C'\fR
that allow type constraints and coercions to be easily tweaked on a
per-attribute basis.
.Sp
Something like this is much harder to do with plain Mouse types:
.Sp
.Vb 7
\&  has name => (
\&    is      => "ro",
\&    isa     => Str\->plus_coercions(
\&      ArrayRef[Str], sub { join " ", @$_ },
\&    ),
\&    coerce  => 1,
\&  );
.Ve
.Sp
Mouse tends to encourage defining coercions globally, so if you wanted
one \fBStr\fR attribute to be able to coerce from \fBArrayRef[Str]\fR, then
\&\fIall\fR \fBStr\fR attributes would coerce from \fBArrayRef[Str]\fR, and they'd
all do that coercion in the same way. (Even if it might make sense to
join by a space in some places, a comma in others, and a line break in
others!)
.IP "\(bu" 4
Type::Tiny provides automatic deep coercions, so if type \fBXyz\fR has a coercion,
the following should \*(L"just work\*(R":
.Sp
.Vb 1
\&  isa xyzlist => ( is => \*(Aqro\*(Aq, isa => ArrayRef[Xyz], coerce => 1 );
.Ve
.IP "\(bu" 4
Type::Tiny offers a wider selection of built-in types.
.IP "\(bu" 4
By using Type::Tiny, you can use the same type constraints and coercions
for attributes and method parameters, in Mouse and non-Mouse code.
.SS "Type::Utils"
.IX Subsection "Type::Utils"
If you've used Mouse::Util::TypeConstraints, you may be accustomed to
using a \s-1DSL\s0 for declaring type constraints:
.PP
.Vb 1
\&  use Mouse::Util::TypeConstraints;
\&  
\&  subtype \*(AqNatural\*(Aq,
\&    as \*(AqInt\*(Aq,
\&    where { $_ > 0 };
.Ve
.PP
There's a module called Type::Utils that provides a very similar \s-1DSL\s0 for
declaring types in Type::Library\-based type libraries.
.PP
.Vb 4
\&  package My::Types {
\&    use Type::Library \-base;
\&    use Type::Utils;
\&    use Types::Standard qw( Int );
\&    
\&    declare \*(AqNatural\*(Aq,
\&      as Int,
\&      where { $_ > 0 };
\&  }
.Ve
.PP
Personally I prefer the more object-oriented way to declare types though.
.PP
In Mouse you might also declare types like this within classes and roles too.
Unlike Mouse, Type::Tiny doesn't keep types in a single global flat namespace,
so this doesn't work quite the same with Type::Utils. It still creates the
type, but it doesn't store it in any type library; the type is returned.
.PP
.Vb 4
\&  package My::Class {
\&    use Mouse;
\&    use Type::Utils;
\&    use Types::Standard qw( Int );
\&    
\&    my $Natural =          # store type in a variable
\&      declare \*(AqNatural\*(Aq,
\&      as Int,
\&      where { $_ > 0 };
\&    
\&    has number => ( is => \*(Aqro\*(Aq, isa => $Natural );
\&  }
.Ve
.PP
But really, isn't the object-oriented way cleaner?
.PP
.Vb 3
\&  package My::Class {
\&    use Mouse;
\&    use Types::Standard qw( Int );
\&    
\&    has number => (
\&      is   => \*(Aqro\*(Aq,
\&      isa  => Int\->where(\*(Aq$_ > 0\*(Aq),
\&    );
\&  }
.Ve
.SS "Type::Tiny and MouseX::Types"
.IX Subsection "Type::Tiny and MouseX::Types"
Types::Standard should be a drop-in replacement for MooseX::Types.
And Types::Common::Numeric and Types::Common::String should easily
replace MouseX::Types::Common::Numeric and MouseX::Types::Common::String.
.PP
That said, if you do with to use a mixture of Type::Tiny and MouseX::Types,
they should fit together pretty seamlessly.
.PP
.Vb 2
\&  use Types::Standard qw( ArrayRef );
\&  use MouseX::Types::Mouse qw( Int );
\&  
\&  # this should just work
\&  my $list_of_nums = ArrayRef[Int];
\&  
\&  # and this
\&  my $list_or_num = ArrayRef | Int;
.Ve
.ie n .SS """\-mouse"" Import Parameter"
.el .SS "\f(CW\-mouse\fP Import Parameter"
.IX Subsection "-mouse Import Parameter"
If you have read this far in the manual, you will know that this is the
usual way to import type constraints:
.PP
.Vb 1
\&  use Types::Standard qw( Int );
.Ve
.PP
And the \f(CW\*(C`Int\*(C'\fR which is imported is a function that takes no arguments and
returns the \fBInt\fR type constraint, which is a blessed object in the
Type::Tiny class.
.PP
Type::Tiny mocks the Mouse::Meta::TypeConstraint \s-1API\s0 so well that most
Mouse and MouseX code will not be able to tell the difference.
.PP
But what if you need a real Mouse::Meta::TypeConstraint object?
.PP
.Vb 1
\&  use Types::Standard \-mouse, qw( Int );
.Ve
.PP
Now the \f(CW\*(C`Int\*(C'\fR function imported will return a genuine native Mouse type
constraint.
.PP
This flag is mostly a throwback from when Type::Tiny native objects
\&\fIdidn't\fR directly work in Mouse. In 99.9% of cases, there is no
reason to use it and plenty of reasons not to. (Mouse native type
constraints don't offer helpful methods like \f(CW\*(C`plus_coercions\*(C'\fR and
\&\f(CW\*(C`where\*(C'\fR.)
.ie n .SS """mouse_type"" Method"
.el .SS "\f(CWmouse_type\fP Method"
.IX Subsection "mouse_type Method"
Another quick way to get a native Mouse type constraint object from a
Type::Tiny object is to call the \f(CW\*(C`mouse_type\*(C'\fR method:
.PP
.Vb 1
\&  use Types::Standard qw( Int );
\&  
\&  my $tiny_type   = Int;
\&  my $mouse_type  = $tiny_type\->mouse_type;
.Ve
.PP
Internally, this is what the \f(CW\*(C`\-mouse\*(C'\fR flag makes imported functions
do.
.SS "Type::Tiny Performance"
.IX Subsection "Type::Tiny Performance"
Type::Tiny should run pretty much as fast as Mouse types do. This is
because, when possible, it will use Mouse's \s-1XS\s0 implementations of type
checks to do the heavy lifting.
.PP
There are a few type constraints where Type::Tiny prefers to do things
without Mouse's help though, for consistency and correctness. For example,
the Mouse \s-1XS\s0 implementation of \fBBool\fR is... strange... it accepts blessed
objects that overload \f(CW\*(C`bool\*(C'\fR, but only if they return false. If they return
true, it's a type constraint error.
.PP
Using Type::Tiny instead of Mouse's type constraints shouldn't make a
significant difference to the performance of your code.
.SH "NEXT STEPS"
.IX Header "NEXT STEPS"
Here's your next step:
.IP "\(bu" 4
Type::Tiny::Manual::UsingWithClassTiny
.Sp
Including how to Type::Tiny in your object's \f(CW\*(C`BUILD\*(C'\fR method, and
third-party shims between Type::Tiny and Class::Tiny.
.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\-2021 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