App::Info::Handler::Carp(3pm)

App::Info::Handler::Carp3pm

Use carp to handle app::info events

Usage

  use App::Info::Category::FooApp;
  use App::Info::Handler::Carp;
  my $carp = App::Info::Handler::Carp->new('carp');
  my $app = App::Info::Category::FooApp->new( on_info => $carp );
  # Or...
  my $app = App::Info::Category::FooApp->new( on_error => 'croak' );

Overview

App::Info::Handler::Carp objects handle App::Info events by passing their messages to Carp functions. This means that if you want errors to croak or info messages to carp, you can easily do that. You'll find, however, that App::Info::Handler::Carp is most effective for info and error events; unknown and prompt events are better handled by event handlers that know how to prompt users for data. See App::Info::Handler::Prompt for an example of that functionality.

Upon loading, App::Info::Handler::Carp registers itself with App::Info::Handler, setting up a number of strings that can be passed to an App::Info concrete subclass constructor. These strings are shortcuts that tell App::Info how to create the proper App::Info::Handler::Carp object for handling events. The registered strings are:

carp

Passes the event message to "Carp::carp()".

warn

An alias for "carp".

croak

Passes the event message to "Carp::croak()".

die

An alias for "croak".

cluck

Passes the event message to "Carp::cluck()".

confess

Passes the event message to "Carp::confess()".

Interface

Constructor

new

  my $carp_handler = App::Info::Handler::Carp->new;
  $carp_handler = App::Info::Handler::Carp->new( level => 'carp' );
  my $croak_handler = App::Info::Handler::Carp->new( level => 'croak' );

Constructs a new App::Info::Handler::Carp object and returns it. It can take a single parameterized argument, "level", which can be any one of the following values:

carp

Constructs a App::Info::Handler::Carp object that passes the event message to "Carp::carp()".

warn

An alias for "carp".

croak

Constructs a App::Info::Handler::Carp object that passes the event message to "Carp::croak()".

die

An alias for "croak".

cluck

Constructs a App::Info::Handler::Carp object that passes the event message to "Carp::cluck()".

confess

Constructs a App::Info::Handler::Carp object that passes the event message to "Carp::confess()".

If the "level" parameter is not passed, "new()" will default to creating an App::Info::Handler::Carp object that passes App::Info event messages to "Carp::carp()".

Support

This module is stored in an open GitHub repository <http://github.com/theory/app-info/>. Feel free to fork and contribute!

Please file bug reports via GitHub Issues <http://github.com/theory/app-info/issues/> or by sending mail to [email protected] <mailto:[email protected]>.

Releases

10 releases since Debian 4.0 (Etch); the text changed 6 times.

  1. 4.0
  2. 5.0–6.0
  3. 7
  4. 8
  5. 9–10
  6. 11
  7. 12–13

Author

David E. Wheeler <[email protected]>

From libapp-info-perl 0.57-4 in Debian 13 (Trixie). Parsed by carta from the page's man source.