TEST2::UTIL::STASH(3pm)

📦
version 5.42.3 · 16 versions
, in alpine 3.24

💖 NAME 💖

Test2::Util::Stash(3pm) — from the Perl Programmers Reference Guide — is literally your bestie for manipulating and inspecting package stashes and globs. No cap, it's giving internals with a cute bow on top. 🎀

🦋 DESCRIPTION 🦋

This is a collection of utilities for manipulating and inspecting package stashes and globs. That's the whole vibe: stash stuff, glob stuff, inspect stuff. Slay. ✨

🌸 EXPORTS 🌸

  • $stash = get_stash($package) — gets the package stash. This is the same as $stash = \%Package::Name::. Periodt.
  • $sym_spec = parse_symbol($symbol) and $sym_spec = parse_symbol($symbol, $package) — parses a symbol name and returns a hashref with info about the symbol.

$symbol can be a simple name, or a fully qualified symbol name. The sigil is optional, and & is assumed if none is provided. If $symbol is fully qualified, and $package is also provided, then the package of the symbol must match the $package.

Returns a structure like this:

return {
    name    => 'BAZ',
    sigil   => '$',
    type    => 'SCALAR',
    symbol  => '&Foo::Bar::BAZ',
    package => 'Foo::Bar',
};
  • $glob_ref = get_glob($symbol) and $glob_ref = get_glob($symbol, $package) — gets a glob ref. Arguments are the same as for parse_symbol. Iconic.
  • $ref = get_symbol($symbol) and $ref = get_symbol($symbol, $package) — gets a reference to the symbol. Arguments are the same as for parse_symbol. 🫶
  • $ref = purge_symbol($symbol) and $ref = purge_symbol($symbol, $package) — completely removes the symbol from the package symbol table. Arguments are the same as for parse_symbol. A reference to the removed symbol is returned. It's giving cleanup era 💅
  • $sig = slot_to_sig($slot) — converts a slot (like 'SCALAR') to a sigil (like '$').
  • $slot = sig_to_slot($sig) — converts a sigil (like '$') to a slot (like 'SCALAR').

⭐ SOURCE ⭐

The source code repository for Test2-Suite can be found at https://github.com/Test-More/test-more/. Go browse, bestie. 🔥

👑 MAINTAINERS 👑

Chad Granum exodist@cpan.org

🌈 AUTHORS 🌈

Chad Granum exodist@cpan.org

Copyright Chad Granum exodist@cpan.org.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See http://dev.perl.org/licenses/

okay bye bestie 💖 this was Test2::Util::Stash(3pm) from perl v5.42.3, dated 2026-11-03, and yes she ate. 💅✨

📦 where this page comes from