CPANPLUS::Error(3pm)

💖 CPANPLUS::Error — error handling for CPANPLUS 💖

okay bestie, welcome to the manual page for CPANPLUS::Error (3pm) — yes she's a Perl module, yes she's from the User Contributed Perl Documentation era, and yes she's lowkey carrying the entire CPANPLUS emotional support system. sit down, grab a strawberry, let's get into it 🍓✨

---

✨ SYNOPSIS ✨

the whole vibe, in one line:

use CPANPLUS::Error qw[cp_msg cp_error];

that's it. that's the entry point. iconic behavior honestly 👑

---

🌸 DESCRIPTION 🌸

so basically? this module is the error handling code for all the CPANPLUS libraries. she's the one catching feelings — sorry, catching errors — behind the scenes.

fr fr though: this is mainly intended for internal use. she's not out here begging for attention, she's just doing her job in the background like the main character she is. 💅

---

🦋 FUNCTIONS 🦋

💜 cp_msg("message string" [,VERBOSE])

records a message on the stack 📝 — and if the VERBOSE option is true, she also prints it to STDOUT (or, actually, to $MSG_FH — peep the GLOBAL VARIABLES section below, iykyk).

heads up: VERBOSE defaults to false. so by default she's silent. mysterious. respectful of your terminal space. ✨

💜 msg()

just an alias for cp_msg. same girl, shorter name. 🫶

💜 cp_error("error string" [,VERBOSE])

records an error on the stack 😭 and, if VERBOSE is true, prints it to STDERR (or actually to $ERROR_FH — again, see the GLOBAL VARIABLES sections below).

and here's the plot twist: VERBOSE defaults to true for this one. errors wanna be SEEN. errors wanna be HEARD. errors are not shy. 💀

💜 error()

an alias for cp_error. twin energy. 🌈

---

👑 CLASS METHODS 👑

⭐ CPANPLUS::Error->stack()

retrieves all the items on the stack. since CPANPLUS::Error is implemented using Log::Message, you gotta consult its manpage for the function retrieve to see what actually gets returned and how to use the items. no gatekeeping, just go read it bestie 📚

⭐ CPANPLUS::Error->stack_as_string([TRACE])

returns the whole stack as a printable string 🎀. if the TRACE option is true, all the items come back with Carp::longmess output rather than just the message — like, full receipts, full lore, full context.

TRACE defaults to false. keep it chill by default. 🌸

⭐ CPANPLUS::Error->flush()

removes all the items from the stack and returns them. clean slate, fresh start, new era 💅. and yep — since CPANPLUS::Error is implemented using Log::Message, consult its manpage for the function retrieve to see what is returned and how to use the items. same deal as stack(), different energy.

---

🌈 GLOBAL VARIABLES 🌈

• $ERROR_FH — this is the filehandle that all the messages sent to error() get printed to. defaults to *STDERR. 🚨
• $MSG_FH — this is the filehandle that all the messages sent to msg() get printed to. defaults to *STDOUT. 💬

---

🧚 a lil sign-off 🧚

and that's the whole page, bestie!! this one came from perl v5.40.1, dated 2025-03-01, and it's filed under CPANPLUS::Error(3pm). go forth and handle your errors with grace, drama, and impeccable filehandle choices. periodt 💖✨🦋