| MooseX::App::Message::Envelope(3pm) | User Contributed Perl Documentation | MooseX::App::Message::Envelope(3pm) |
MooseX::App::Message::Envelope - Message presented to the user
Whenever MooseX::App needs to pass a message to the user, it does so by generating a MooseX::App::Message::Envelope object. The object usually contains one or more blocks (MooseX::App::Message::Block) and can be easily stringified.
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.
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;
If
Stringifies the messages
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).
Adds a new message block. Param must be a MooseX::App::Message::Block
Returns a list on message blocks.
Message block accessor.
Exitcode accessor.
Check if exitcode is set.
Stringification of this object is overloaded.
You can call any method on the message class.
| 2022-10-16 | perl v5.34.0 |