.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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::Role 3"
.TH Type::Tiny::Role 3 2024-03-13 "perl v5.38.2" "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::Role \- type constraints based on the "DOES" method
.SH SYNOPSIS
.IX Header "SYNOPSIS"
Using via Types::Standard:
.PP
.Vb 3
\&  package Local::Horse {
\&    use Moo;
\&    use Types::Standard qw( Str ConsumerOf );
\&    
\&    has name => (
\&      is       => \*(Aqro\*(Aq,
\&      isa      => Str,
\&    );
\&    
\&    has owner => (
\&      is       => \*(Aqro\*(Aq,
\&      isa      => ConsumerOf[ \*(AqLocal::Traits::DoesOwnership\*(Aq ],
\&      default  => sub { Local::Person\->new },
\&    );
\&  }
.Ve
.PP
Using Type::Tiny::Class's export feature:
.PP
.Vb 6
\&  package Local::Horse {
\&    use Moo;
\&    use Types::Standard qw( Str );
\&    use Type::Tiny::Role (
\&      Owner => { role => \*(AqLocal::Traits::DoesOwnership\*(Aq },
\&    );
\&    
\&    has name => (
\&      is       => \*(Aqro\*(Aq,
\&      isa      => Str,
\&    );
\&    
\&    has owner => (
\&      is       => \*(Aqro\*(Aq,
\&      isa      => Owner,
\&      default  => sub { Local::Person\->new },
\&    );
\&  }
.Ve
.PP
Using Type::Tiny::Role's object-oriented interface:
.PP
.Vb 4
\&  package Local::Horse {
\&    use Moo;
\&    use Types::Standard qw( Str );
\&    use Type::Tiny::Class;
\&    
\&    my $Owner = Type::Tiny::Role\->new(
\&      role => \*(AqLocal::Traits::DoesOwnership\*(Aq,
\&    );
\&    
\&    has name => (
\&      is       => \*(Aqro\*(Aq,
\&      isa      => Str,
\&    );
\&    
\&    has owner => (
\&      is       => \*(Aqro\*(Aq,
\&      isa      => $Owner,
\&      default  => sub { Local::Person\->new },
\&    );
\&  }
.Ve
.PP
Using Type::Utils's functional interface:
.PP
.Vb 4
\&  package Local::Horse {
\&    use Moo;
\&    use Types::Standard qw( Str );
\&    use Type::Utils;
\&    
\&    my $Owner = role_type \*(AqLocal::Traits::DoesOwnership\*(Aq;
\&    
\&    has name => (
\&      is       => \*(Aqro\*(Aq,
\&      isa      => Str,
\&    );
\&    
\&    has owner => (
\&      is       => \*(Aqro\*(Aq,
\&      isa      => $Owner,
\&      default  => sub { Local::Person\->new },
\&    );
\&  }
.Ve
.SH STATUS
.IX Header "STATUS"
This module is covered by the
Type-Tiny stability policy.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Type constraints of the general form \f(CW\*(C`{ $_\->DOES("Some::Role") }\*(C'\fR.
.PP
This package inherits from Type::Tiny; see that for most documentation.
Major differences are listed below:
.SS Attributes
.IX Subsection "Attributes"
.ie n .IP """role""" 4
.el .IP \f(CWrole\fR 4
.IX Item "role"
The role for the constraint.
.Sp
Note that this package doesn't subscribe to any particular flavour of roles
(Moose::Role, Mouse::Role, Moo::Role, Role::Tiny, etc). It simply
trusts the object's \f(CW\*(C`DOES\*(C'\fR method (see UNIVERSAL).
.ie n .IP """constraint""" 4
.el .IP \f(CWconstraint\fR 4
.IX Item "constraint"
Unlike Type::Tiny, you \fIcannot\fR pass a constraint coderef to the constructor.
Instead rely on the default.
.ie n .IP """inlined""" 4
.el .IP \f(CWinlined\fR 4
.IX Item "inlined"
Unlike Type::Tiny, you \fIcannot\fR pass an inlining coderef to the constructor.
Instead rely on the default.
.ie n .IP """parent""" 4
.el .IP \f(CWparent\fR 4
.IX Item "parent"
Parent is always \fBTypes::Standard::Object\fR, and cannot be passed to the
constructor.
.SS Methods
.IX Subsection "Methods"
.ie n .IP stringifies_to($constraint) 4
.el .IP \f(CWstringifies_to($constraint)\fR 4
.IX Item "stringifies_to($constraint)"
See Type::Tiny::ConstrainedObject.
.ie n .IP numifies_to($constraint) 4
.el .IP \f(CWnumifies_to($constraint)\fR 4
.IX Item "numifies_to($constraint)"
See Type::Tiny::ConstrainedObject.
.ie n .IP """with_attribute_values($attr1 => $constraint1, ...)""" 4
.el .IP "\f(CWwith_attribute_values($attr1 => $constraint1, ...)\fR" 4
.IX Item "with_attribute_values($attr1 => $constraint1, ...)"
See Type::Tiny::ConstrainedObject.
.SS Exports
.IX Subsection "Exports"
Type::Tiny::Role can be used as an exporter.
.PP
.Vb 1
\&  use Type::Tiny::Role \*(AqMyApp::Printable\*(Aq;
.Ve
.PP
This will export the following functions into your namespace:
.ie n .IP """MyAppPrintable""" 4
.el .IP \f(CWMyAppPrintable\fR 4
.IX Item "MyAppPrintable"
.PD 0
.ie n .IP "is_MyAppPrintable( $value )" 4
.el .IP "\f(CWis_MyAppPrintable( $value )\fR" 4
.IX Item "is_MyAppPrintable( $value )"
.ie n .IP "assert_MyAppPrintable( $value )" 4
.el .IP "\f(CWassert_MyAppPrintable( $value )\fR" 4
.IX Item "assert_MyAppPrintable( $value )"
.ie n .IP "to_MyAppPrintable( $value )" 4
.el .IP "\f(CWto_MyAppPrintable( $value )\fR" 4
.IX Item "to_MyAppPrintable( $value )"
.PD
.PP
Multiple types can be exported at once:
.PP
.Vb 1
\&  use Type::Tiny::Role qw( MyApp::Printable MyApp::Sendable );
.Ve
.SH BUGS
.IX Header "BUGS"
Please report any bugs to
<https://github.com/tobyink/p5\-type\-tiny/issues>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Type::Tiny::Manual.
.PP
Type::Tiny.
.PP
Moose::Meta::TypeConstraint::Role.
.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\-2023 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"
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.