.\" -*- 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::Spec 3pm"
.TH Mouse::Spec 3pm 2024-03-07 "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
Mouse::Spec \- To what extent Mouse is compatible with Moose
.SH VERSION
.IX Header "VERSION"
This document describes Mouse version v2.5.10
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use Mouse::Spec;
\&
\&    printf "Mouse/%s is compatible with Moose/%s\en",
\&        Mouse::Spec\->MouseVersion, Mouse::Spec\->MooseVersion;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Mouse is a subset of Moose. This document describes to what extend Mouse is
compatible (and incompatible) with Moose.
.SS "Compatibility with Moose"
.IX Subsection "Compatibility with Moose"
\fISugary APIs\fR
.IX Subsection "Sugary APIs"
.PP
The sugary APIs are highly compatible with Moose. Methods which have the
same name as Moose's are expected to be compatible with Moose's.
.PP
\fIMeta object protocols\fR
.IX Subsection "Meta object protocols"
.PP
Meta object protocols are a subset of the counterpart of Moose.
Their methods which have the same name as Moose's are expected to be
compatible with Moose's. Feel free to use these methods even if they
are not documented.
.PP
However, there are differences between Moose's MOP and Mouse's.
For example, meta object protocols in Mouse have no attributes by default,
so \f(CW\*(C`$metaclass\->meta\->make_immutable()\*(C'\fR will not work as you expect.
\&\fBDon not make metaclasses immutable\fR.
.PP
\fIMouse::Meta::Instance\fR
.IX Subsection "Mouse::Meta::Instance"
.PP
Meta instance mechanism is not implemented, so you cannot change the reftype
of Mouse objects in the same way as Moose.
.PP
\fIRole exclusion\fR
.IX Subsection "Role exclusion"
.PP
Role exclusion, \f(CWexclude()\fR, is not implemented.
.PP
\fI\-metaclass in Mouse::Exporter\fR
.IX Subsection "-metaclass in Mouse::Exporter"
.PP
\&\f(CW\*(C`use Mouse \-metaclass => ...\*(C'\fR are not implemented.
Use \f(CW\*(C`use Mouse \-traits => ...\*(C'\fR instead.
.PP
\fIMouse::Meta::Attribute::Native\fR
.IX Subsection "Mouse::Meta::Attribute::Native"
.PP
Native traits are not supported directly, but \f(CW\*(C`MouseX::NativeTraits\*(C'\fR is
available on CPAN. Once you have installed it, you can use it as the same way
in Moose. That is, native traits are automatically loaded by Mouse.
.PP
See MouseX::NativeTraits for details.
.SS "Notes about Moose::Cookbook"
.IX Subsection "Notes about Moose::Cookbook"
Many recipes in Moose::Cookbook fit Mouse, including:
.IP \(bu 4
Moose::Cookbook::Basics::Recipe1 \- The (always classic) \fBPoint\fR example
.IP \(bu 4
Moose::Cookbook::Basics::Recipe2 \- A simple \fBBankAccount\fR example
.IP \(bu 4
Moose::Cookbook::Basics::Recipe3 \- A lazy \fBBinaryTree\fR example
.IP \(bu 4
Moose::Cookbook::Basics::Recipe4 \- Subtypes, and modeling a simple \fBCompany\fR class hierarchy
.IP \(bu 4
Moose::Cookbook::Basics::Recipe5 \- More subtypes, coercion in a \fBRequest\fR class
.IP \(bu 4
Moose::Cookbook::Basics::Recipe6 \- The augment/inner example
.IP \(bu 4
Moose::Cookbook::Basics::Recipe7 \- Making Moose fast with immutable
.IP \(bu 4
Moose::Cookbook::Basics::Recipe8 \- Builder methods and lazy_build
.IP \(bu 4
Moose::Cookbook::Basics::Recipe9 \- Operator overloading, subtypes, and coercion
.IP \(bu 4
Moose::Cookbook::Basics::Recipe10 \- Using BUILDARGS and BUILD to hook into object construction
.IP \(bu 4
Moose::Cookbook::Roles::Recipe1 \- The Moose::Role example
.IP \(bu 4
Moose::Cookbook::Roles::Recipe2 \- Advanced Role Composition \- method exclusion and aliasing
.IP \(bu 4
Moose::Cookbook::Roles::Recipe3 \- Applying a role to an object instance
.IP \(bu 4
Moose::Cookbook::Meta::Recipe2 \- A meta-attribute, attributes with labels
.IP \(bu 4
Moose::Cookbook::Meta::Recipe3 \- Labels implemented via attribute traits
.IP \(bu 4
Moose::Cookbook::Extending::Recipe3 \- Providing an alternate base object class
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mouse
.PP
Moose
.PP
Moose::Manual
.PP
Moose::Cookbook