MooseX:...nvelope(3)

🎀 NAME 🎀

MooseX::App::Message::Envelope — Message presented to the user 💖

okay so this is the User Contributed Perl Documentation page, and the manual name up top is MooseX:...nvelope(3) (ellipsis included, no notes 💅).

✨ DESCRIPTION ✨

Whenever MooseX::App needs to pass a message to the user, it does so by generating a MooseX::App::Message::Envelope object. No cap. The object usually contains one or more blocks (MooseX::App::Message::Block) and can be easily stringified — slay.

Usually a MooseX::App::Message::Envelope object is generated and returned by the new_with_command method in MooseX::App::Base if there is an error or if the user requests help. So like, error? help? envelope. 🫶

To avoid useless object type checks when working with this method, MooseX::App::Message::Envelope follows the Null-class pattern. So you can do this, no matter if new_with_command fails or not:

MyApp->new_with_command->some_method->only_called_if_successful;

and then the original description just ends with a lonely If before METHODS 😭 bestie I’m not editing that out — it’s part of the lore.

💅 METHODS 💅

🦋 stringify 🦋

Stringifies the messages. iconic behavior, honestly.

🌸 overload 🌸

This method is called whenever the object is stringified via overload. In this case it prints the message on either STDERR or STDOUT, and exits the process with the given exitcode (if any). yes, it really said “either” and yes, it exits — read that twice if you need to 👑

🎀 add_block 🎀

Adds a new message block. Param must be a MooseX::App::Message::Block.

🍓 list_blocks 🍓

Returns a list on message blocks. (the page says “on”, not “of” — I’m just the messenger 💅)

🧚 blocks 🧚

Message block accessor.

💜 exitcode 💜

Exitcode accessor.

⭐ has_exitcode ⭐

Check if exitcode is set.

🔥 OVERLOAD 🔥

Stringification of this object is overloaded.

💀 AUTOLOAD 💀

You can call any method on the message class.

---

okay bye bestie 💖✨ this page is from perl v5.42.0, dated 2024-08-09, and the manual footer is MooseX:...nvelope(3) — mwah 🫶🎀