Mouse::Util

Section: User Contributed Perl Documentation (3pm)
Updated: 2022-10-20
Index Return to Main Contents

NAME

Mouse::Util - Utilities for working with Mouse classes

VERSION

This document describes Mouse version v2.5.10

SYNOPSIS

    use Mouse::Util; # turns on strict and warnings

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.

IMPLEMENTATIONS FOR

Moose::Util functions

The following functions are exportable.

"find_meta($class_or_obj)"

The same as "Mouse::Util::class_of()".

"does_role($class_or_obj, $role_or_obj)"

"resolve_metaclass_alias($category, $name, %options)"

"apply_all_roles($applicant, @roles)"

"english_listi(@items)"

Class::MOP functions

The following functions are not exportable.

"Mouse::Util::is_class_loaded($classname) -> Bool"

Returns whether $classname is actually loaded or not. It uses a heuristic which involves checking for the existence of $VERSION, @ISA, and any locally-defined method.

"Mouse::Util::load_class($classname) -> ClassName"

This will load a given $classname (or die if it is not loadable). This function can be used in place of tricks like "eval "use $module ()"" or using "require".

"Mouse::Util::class_of($classname_or_object) -> MetaClass"

"Mouse::Util::get_metaclass_by_name($classname) -> MetaClass"

"Mouse::Util::get_all_metaclass_instances() -> (MetaClasses)"

"Mouse::Util::get_all_metaclass_names() -> (ClassNames)"