.\" -*- 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::Util 3pm"
.TH Mouse::Util 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::Util \- Utilities for working with Mouse classes
.SH VERSION
.IX Header "VERSION"
This document describes Mouse version v2.5.10
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use Mouse::Util; # turns on strict and warnings
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module provides a set of utility functions. Many of these
functions are intended for use in Mouse itself or MouseX modules, but
some of them may be useful for use in your own code.
.SH "IMPLEMENTATIONS FOR"
.IX Header "IMPLEMENTATIONS FOR"
.SS "Moose::Util functions"
.IX Subsection "Moose::Util functions"
The following functions are exportable.
.PP
\fR\f(CIfind_meta($class_or_obj)\fR\fI\fR
.IX Subsection "find_meta($class_or_obj)"
.PP
The same as \f(CWMouse::Util::class_of()\fR.
.PP
\fR\f(CI\*(C`does_role($class_or_obj, $role_or_obj)\*(C'\fR\fI\fR
.IX Subsection "does_role($class_or_obj, $role_or_obj)"
.PP
\fR\f(CI\*(C`resolve_metaclass_alias($category, $name, %options)\*(C'\fR\fI\fR
.IX Subsection "resolve_metaclass_alias($category, $name, %options)"
.PP
\fR\f(CI\*(C`apply_all_roles($applicant, @roles)\*(C'\fR\fI\fR
.IX Subsection "apply_all_roles($applicant, @roles)"
.PP
\fR\f(CIenglish_listi(@items)\fR\fI\fR
.IX Subsection "english_listi(@items)"
.SS "Class::MOP functions"
.IX Subsection "Class::MOP functions"
The following functions are not exportable.
.PP
\fR\f(CI\*(C`Mouse::Util::is_class_loaded($classname) \-> Bool\*(C'\fR\fI\fR
.IX Subsection "Mouse::Util::is_class_loaded($classname) -> Bool"
.PP
Returns whether \fR\f(CI$classname\fR\fI\fR is actually loaded or not.
It uses a heuristic which involves checking for the existence of
\&\f(CW$VERSION\fR, \f(CW@ISA\fR, and any locally-defined method.
.PP
\fR\f(CI\*(C`Mouse::Util::load_class($classname) \-> ClassName\*(C'\fR\fI\fR
.IX Subsection "Mouse::Util::load_class($classname) -> ClassName"
.PP
This will load a given \fR\f(CI$classname\fR\fI\fR (or die if it is not loadable).
This function can be used in place of tricks like
\&\f(CW\*(C`eval "use $module ()"\*(C'\fR or using \f(CW\*(C`require\*(C'\fR.
.PP
\fR\f(CI\*(C`Mouse::Util::class_of($classname_or_object) \-> MetaClass\*(C'\fR\fI\fR
.IX Subsection "Mouse::Util::class_of($classname_or_object) -> MetaClass"
.PP
\fR\f(CI\*(C`Mouse::Util::get_metaclass_by_name($classname) \-> MetaClass\*(C'\fR\fI\fR
.IX Subsection "Mouse::Util::get_metaclass_by_name($classname) -> MetaClass"
.PP
\fR\f(CI\*(C`Mouse::Util::get_all_metaclass_instances() \-> (MetaClasses)\*(C'\fR\fI\fR
.IX Subsection "Mouse::Util::get_all_metaclass_instances() -> (MetaClasses)"
.PP
\fR\f(CI\*(C`Mouse::Util::get_all_metaclass_names() \-> (ClassNames)\*(C'\fR\fI\fR
.IX Subsection "Mouse::Util::get_all_metaclass_names() -> (ClassNames)"
.SS "mro (or MRO::Compat)"
.IX Subsection "mro (or MRO::Compat)"
\fR\f(CI\*(C`get_linear_isa\*(C'\fR\fI\fR
.IX Subsection "get_linear_isa"
.SS Sub::Identify
.IX Subsection "Sub::Identify"
\fR\f(CI\*(C`get_code_info\*(C'\fR\fI\fR
.IX Subsection "get_code_info"
.SH "Mouse specific utilities"
.IX Header "Mouse specific utilities"
\fR\f(CI\*(C`not_supported\*(C'\fR\fI\fR
.IX Subsection "not_supported"
.PP
\fR\f(CI\*(C`get_code_package\*(C'\fR\fI\fR
.IX Subsection "get_code_package"
.PP
\fR\f(CI\*(C`get_code_ref\*(C'\fR\fI\fR
.IX Subsection "get_code_ref"
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Moose::Util
.PP
Class::MOP
.PP
Sub::Identify
.PP
mro
.PP
MRO::Compat