.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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 "MouseX::Types::Path::Class 3pm"
.TH MouseX::Types::Path::Class 3pm "2021-01-06" "perl v5.32.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"
MouseX::Types::Path::Class \- A Path::Class type library for Mouse
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.SS "\s-1CLASS TYPES\s0"
.IX Subsection "CLASS TYPES"
.Vb 3
\&  package MyApp;
\&  use Mouse;
\&  use MouseX::Types::Path::Class;
\&
\&  has \*(Aqdir\*(Aq => (
\&      is       => \*(Aqro\*(Aq,
\&      isa      => \*(AqPath::Class::Dir\*(Aq,
\&      required => 1,
\&      coerce   => 1,
\&  );
\&
\&  has \*(Aqfile\*(Aq => (
\&      is       => \*(Aqro\*(Aq,
\&      isa      => \*(AqPath::Class::File\*(Aq,
\&      required => 1,
\&      coerce   => 1,
\&  );
.Ve
.SS "\s-1CUSTOM TYPES\s0"
.IX Subsection "CUSTOM TYPES"
.Vb 3
\&  package MyApp;
\&  use Mouse;
\&  use MouseX::Types::Path::Class qw(Dir File);
\&
\&  has \*(Aqdir\*(Aq => (
\&      is       => \*(Aqro\*(Aq,
\&      isa      => Dir,
\&      required => 1,
\&      coerce   => 1,
\&  );
\&
\&  has \*(Aqfile\*(Aq => (
\&      is       => \*(Aqro\*(Aq,
\&      isa      => File,
\&      required => 1,
\&      coerce   => 1,
\&  );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
MouseX::Types::Path::Class creates common Mouse types,
coercions and option specifications useful for dealing
with Path::Class objects as Mouse attributes.
.PP
Coercions (see Mouse::Util::TypeConstraints) are made
from both \f(CW\*(C`Str\*(C'\fR and \f(CW\*(C`ArrayRef\*(C'\fR to both Path::Class::Dir and
Path::Class::File objects.
If you have MouseX::Getopt installed,
the Getopt option type (\*(L"=s\*(R") will be added for both
Path::Class::Dir and Path::Class::File.
.SH "TYPES"
.IX Header "TYPES"
.SS "Dir"
.IX Subsection "Dir"
.RS 4
A Path::Class::Dir class type.
.Sp
Coerces from \f(CW\*(C`Str\*(C'\fR and \f(CW\*(C`ArrayRef\*(C'\fR via \*(L"new\*(R" in Path::Class::Dir.
.RE
.SS "File"
.IX Subsection "File"
.RS 4
A Path::Class::File class type.
.Sp
Coerces from \f(CW\*(C`Str\*(C'\fR and \f(CW\*(C`ArrayRef\*(C'\fR via \*(L"new\*(R" in Path::Class::File.
.RE
.SH "AUTHOR"
.IX Header "AUTHOR"
\&\s-1NAKAGAWA\s0 Masaki <masaki@cpan.org>
.SH "THANKS TO"
.IX Header "THANKS TO"
\&\*(L"\s-1AUTHOR\*(R"\s0 in MooseX::Types::Path::Class
.SH "LICENSE"
.IX Header "LICENSE"
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mouse, MouseX::Types,
.PP
Path::Class,
.PP
MooseX::Types::Path::Class