.\" -*- 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 "Mouse::Meta::TypeConstraint 3pm"
.TH Mouse::Meta::TypeConstraint 3pm 2023-07-26 "perl v5.38.0" "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
Mouse::Meta::TypeConstraint \- The Mouse Type Constraint metaclass
.SH VERSION
.IX Header "VERSION"
This document describes Mouse version v2.5.10
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This class represents a type constraint, including built-in
type constraints, union type constraints, parameterizable/
parameterized type constraints, as well as custom type
constraints
.SH METHODS
.IX Header "METHODS"
.ie n .IP """Mouse::Meta::TypeConstraint\->new(%options)""" 4
.el .IP \f(CWMouse::Meta::TypeConstraint\->new(%options)\fR 4
.IX Item "Mouse::Meta::TypeConstraint->new(%options)"
.PD 0
.ie n .IP """$constraint\->name""" 4
.el .IP \f(CW$constraint\->name\fR 4
.IX Item "$constraint->name"
.ie n .IP """$constraint\->parent""" 4
.el .IP \f(CW$constraint\->parent\fR 4
.IX Item "$constraint->parent"
.ie n .IP """$constraint\->constraint""" 4
.el .IP \f(CW$constraint\->constraint\fR 4
.IX Item "$constraint->constraint"
.ie n .IP """$constraint\->has_coercion""" 4
.el .IP \f(CW$constraint\->has_coercion\fR 4
.IX Item "$constraint->has_coercion"
.ie n .IP """$constraint\->message""" 4
.el .IP \f(CW$constraint\->message\fR 4
.IX Item "$constraint->message"
.ie n .IP """$constraint\->is_a_type_of($name or $object)""" 4
.el .IP "\f(CW$constraint\->is_a_type_of($name or $object)\fR" 4
.IX Item "$constraint->is_a_type_of($name or $object)"
.ie n .IP """$constraint\->coerce($value)""" 4
.el .IP \f(CW$constraint\->coerce($value)\fR 4
.IX Item "$constraint->coerce($value)"
.ie n .IP """$constraint\->check($value)""" 4
.el .IP \f(CW$constraint\->check($value)\fR 4
.IX Item "$constraint->check($value)"
.ie n .IP """$constraint\->assert_valid($value)""" 4
.el .IP \f(CW$constraint\->assert_valid($value)\fR 4
.IX Item "$constraint->assert_valid($value)"
.ie n .IP """$constraint\->get_message($value)""" 4
.el .IP \f(CW$constraint\->get_message($value)\fR 4
.IX Item "$constraint->get_message($value)"
.ie n .IP """$constraint\->create_child_type(%options)""" 4
.el .IP \f(CW$constraint\->create_child_type(%options)\fR 4
.IX Item "$constraint->create_child_type(%options)"
.PD
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Moose::Meta::TypeConstraint