Moose::Meta::Role(3)

📦

version 2.4000 · 14 versions

💖 Moose::Meta::Role 💖

okay bestie, welcome to Moose::Meta::Role — yes that's the manual page name too, we're keeping it cute and consistent 🎀. It's the Moose Role metaclass, and it's literally the brain behind how roles do their thing.

✨ VERSION ✨

version 2.4000 — fresh, iconic, no notes. 💅

🌸 DESCRIPTION 🌸

So. This class is a subclass of Class::MOP::Module that piles a whole extra layer of Moose-specific functionality on top. It's giving "module but make it Moose."

Its API looks a lot like Moose::Meta::Class, bestie — like, same energy, same vibes — but internally it implements many things differently. And heads up: this may change in the future. So don't get too attached to the internals, okay? 🙈

🦋 INHERITANCE 🦋

Moose::Meta::Role is a subclass of Class::MOP::Module. Family tree confirmed, no cap. 🌳

👑 METHODS 👑

🧚 Construction 🧚

Moose::Meta::Role->initialize($role_name) — makes a brand new role object with the name you hand it. Baby role, born. 🍼
Moose::Meta::Role->combine( [ $role => { ... } ], [ $role ], ... ) — takes a list of array references. Each array ref should have a role name or a Moose::Meta::Role object as its first element. Second element is an optional hash reference, and that hash can carry -excludes and -alias keys to control how methods get composed out of the role. The return value is a shiny new Moose::Meta::Role::Composite representing the combined roles. Slay. 🔥
$metarole->composition_class_roles — when you're combining multiple roles with combine, this method grabs a list of role names to apply to the Moose::Meta::Role::Composite instance that combine returns. The default implementation returns an empty list. Extensions that need to hook into role combination can wrap this method to return extra role names. Very "let me add to that" of them. 💅
Moose::Meta::Role->create($name, %options) — identical to the Moose::Meta::Class create method. Twin behaviour, no divergence. 👯
Moose::Meta::Role->create_anon_role — identical to the Moose::Meta::Class create_anon_class method. Anonymous, mysterious, main character. 🕶️
$metarole->is_anon_role — returns true if the role is an anonymous role. Secret identity check. 🥸
$metarole->consumers — returns a list of names of classes and roles which consume this role. All the people who love this role back. 🫶

💜 Role application 💜

$metarole->apply( $thing, @options ) — applies a role to the given $thing. That $thing can be another Moose::Meta::Role, an object, a Moose::Meta::Class object, or a (non-meta) object instance. The options get passed directly to the constructor for the appropriate Moose::Meta::Role::Application subclass.

⚠️ Heads up bestie: this will apply the role even if the $thing in question already does this role. does_role in Moose::Util is the convenient wrapper for finding out if role application is actually necessary. Use it, don't be messy. 💀

🌈 Roles and other roles 🌈

$metarole->get_roles — returns an array reference of roles which this role does. And yes, this list may include duplicates. It's not a set, it's a vibe.
$metarole->calculate_all_roles — returns a unique list of all the roles this role does, plus all the roles those roles do. Recursive bestie energy. 🌀
$metarole->does_role($role) — give it a role name or a Moose::Meta::Role object and it returns true if this role does the given role. ✨
$metarole->add_role($role) — given a Moose::Meta::Role object, adds it to the list of roles that this role does. New friend added to the group chat. 🎀
$metarole->get_excluded_roles_list — returns a list of role names which this role excludes. The blocked list, basically. 🚫
$metarole->excludes_role($role_name) — given a role name, returns true if this role excludes it. Are they blocked? Find out. 👀
$metarole->add_excluded_roles(@role_names) — given one or more role names, adds them to the list of excluded roles. Blocked, collectively. 🙅

🌟 Methods 🌟

The methods for dealing with a role's methods are all identical in API and behavior to the same methods in Class::MOP::Class. Like, every single one. Copy-paste behaviour, zero drama. 💚

$metarole->method_metaclass — returns the method metaclass name for the role. Defaults to Moose::Meta::Role::Method. That's the one. ⭐
$metarole->get_method($name)
$metarole->has_method($name)
$metarole->add_method( $name, $body )
$metarole->get_method_list
$metarole->find_method_by_name($name)

These methods are all identical to the methods of the same name in Class::MOP::Class. Periodt. 💅

🍓 Attributes 🍓

Same as methods, bestie: the methods for dealing with a role's attributes are all identical in API and behavior to the same methods in Class::MOP::Class.

BUT. Huge but. 🚨 Attributes stored in this class are not stored as objects. Instead, the attribute definition is stored as a hash reference. When a role gets composed into a class, that hash reference is passed directly to the metaclass's add_attribute method.

This is quite likely to change in the future. So like, don't build your whole personality around it, okay? 😭

$metarole->get_attribute($attribute_name)
$metarole->has_attribute($attribute_name)
$metarole->get_attribute_list
$metarole->add_attribute($name, %options)
$metarole->remove_attribute($attribute_name)

💫 Overload introspection and creation 💫

The methods for dealing with a role's overloads are all identical in API and behavior to the same methods in Class::MOP::Class. Consistent queen. 👑

$metarole->is_overloaded
$metarole->get_overloaded_operator($op)
$metarole->has_overloaded_operator($op)
$metarole->get_overload_list
$metarole->get_all_overloaded_operators
$metarole->add_overloaded_operator($op, $impl)
$metarole->remove_overloaded_operator($op)

🧁 Required methods 🧁

$metarole->get_required_method_list — returns the list of methods required by the role. The non-negotiables. 📋
$metarole->requires_method($name) — returns true if the role requires the named method. Is it mandatory? Yes bestie, it is. ✅
$metarole->add_required_methods(@names) — adds the named methods to the role's list of required methods. Requirements loading… ⏳
$metarole->remove_required_methods(@names) — removes the named methods from the role's list of required methods. Requirement revoked. ✂️
$metarole->add_conflicting_method(%params) — instantiates the parameters as a Moose::Meta::Role::Method::Conflicting object, then adds it to the required method list. Conflict, but make it a method. 💥

🎀 Method modifiers 🎀

These methods act like their counterparts in Class::MOP::Class and Moose::Meta::Class. Same energy, same behaviour. 💕

HOWEVER — and this is the tea ☕ — method modifiers are simply stored internally, and they are not applied until the role itself is applied to a class or object. They just sit there. Waiting. Patiently. 🙈

$metarole->add_after_method_modifier($method_name, $method)
$metarole->add_around_method_modifier($method_name, $method)
$metarole->add_before_method_modifier($method_name, $method)
$metarole->add_override_method_modifier($method_name, $method)

These methods all add an appropriate modifier to the internal list of modifiers. Internal list stays winning. 📝

$metarole->has_after_method_modifiers
$metarole->has_around_method_modifiers
$metarole->has_before_method_modifiers
$metarole->has_override_method_modifier

Return true if the role has any modifiers of the given type. Vibe check on the modifiers. 🔍

$metarole->get_after_method_modifiers($method_name)
$metarole->get_around_method_modifiers($method_name)
$metarole->get_before_method_modifiers($method_name)

Given a method name, returns a list of the appropriate modifiers for that method. Modifiers, delivered. 📦

$metarole->get_override_method_modifier($method_name) — given a method name, returns the override method modifier for that method, if it has one. If not, well… it doesn't. 🤷

🔮 Introspection 🔮

Moose::Meta::Role->meta — this will return a Class::MOP::Class instance for this class. Meta on meta on meta. 🪞✨

💀 BUGS 💀

See "BUGS" in Moose for details on reporting bugs. Go tell the Moose people, they want to know. 🐛➡️📮

🫶 AUTHORS 🫶

Stevan Little <stevan@cpan.org>
Dave Rolsky <autarch@urth.org>
Jesse Luehrs <doy@cpan.org>
Shawn M Moore <sartak@cpan.org>
יובל קוג'מן (Yuval Kogman) <nothingmuch@woobling.org>
Karen Etheridge <ether@cpan.org>
Florian Ragwitz <rafl@debian.org>
Hans Dieter Pearcey <hdp@cpan.org>
Chris Prather <chris@prather.org>
Matt S Trout <mstrout@cpan.org>

The whole squad. Legends only. 👑💖

🌸 COPYRIGHT AND LICENSE 🌸

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. Free as in freedom, bestie. 🕊️

okay that's the whole page!! 🌈 this was Moose::Meta::Role(3) from the User Contributed Perl Documentation, version 2.4000, and it was generated by perl v5.42.0 on 2025-07-25. ty for reading, mwah 💋 🎀✨🦋

📦 where this page comes from

fedora 43: perl-Moose 2.4000-4.fc43 · GPL-1.0-or-later OR Artistic-1.0-Perl
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms