.\" Automatically generated by Pod::Man 4.09 (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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "MooseX::Meta::TypeConstraint::ForceCoercion 3pm"
.TH MooseX::Meta::TypeConstraint::ForceCoercion 3pm "2018-07-03" "perl v5.26.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"
MooseX::Meta::TypeConstraint::ForceCoercion \- Force coercion when validating type constraints
.SH "VERSION"
.IX Header "VERSION"
version 0.01
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&    use MooseX::Types:::Moose qw/Str Any/;
\&    use Moose::Util::TypeConstraints;
\&    use MooseX::Meta::TypeConstraint::ForceCoercion;
\&
\&    # get any type constraint
\&    my $tc = Str;
\&
\&    # declare one or more coercions for it
\&    coerce $tc,
\&        from Any,
\&        via { ... };
\&
\&    # wrap the $tc to force coercion
\&    my $coercing_tc = MooseX::Meta::TypeConstraint::ForceCoercion\->new(
\&        type_constraint => $tc,
\&    );
\&
\&    # check a value against new type constraint. this will run the type
\&    # coercions for the wrapped type, even if the value already passes
\&    # validation before coercion. it will fail if the value couldn\*(Aqt be
\&    # coerced
\&    $coercing_tc\->check(\*(AqAffe\*(Aq);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class allows to wrap any \f(CW\*(C`Moose::Meta::TypeConstraint\*(C'\fR in a way that will
force coercion of the value when checking or validating a value against it.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "type_constraint"
.IX Subsection "type_constraint"
The type constraint to wrap. All methods except for \f(CW\*(C`validate\*(C'\fR and \f(CW\*(C`check\*(C'\fR
are delegated to the value of this attribute.
.SH "METHODS"
.IX Header "METHODS"
.SS "check ($value)"
.IX Subsection "check ($value)"
Same as \f(CW\*(C`Moose::Meta::TypeConstraint::check\*(C'\fR, except it will always try to
coerce \f(CW$value\fR before checking it against the actual type constraint. If
coercing fails the check will fail, too.
.ie n .SS "validate ($value, $coerced_ref?)"
.el .SS "validate ($value, \f(CW$coerced_ref\fP?)"
.IX Subsection "validate ($value, $coerced_ref?)"
Same as \f(CW\*(C`Moose::Meta::TypeConstraint::validate\*(C'\fR, except it will always try to
coerce \f(CW$value\fR before validating it against the actual type constraint. If
coercing fails the validation will fail, too.
.PP
If coercion was successful and a \f(CW$coerced_ref\fR references was passed, the
coerced value will be stored in that.
.SH "AUTHOR"
.IX Header "AUTHOR"
.Vb 1
\&  Florian Ragwitz <rafl@debian.org>
.Ve
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2009 by Florian Ragwitz.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as perl itself.