/ 
Throwable-X-0.003
River stage one • 4 direct dependents • 7 total dependents
/ Throwable::X::WithMessage::Errf

NAME

Throwable::X::WithMessage::Errf - an exception with a String::Errf-powered message

VERSION

version 0.003

SYNOPSIS

In your class...

package Errfy;
use Moose;

with 'Throwable::X::WithMessage::Errf';

has payload => (
  is  => 'ro',
  isa => 'HashRef',
  required => 1,
);

Then...

my $thing = Errfy->new({
  message => "%{error_count;error}n encountered at %{when}t",
  payload => {
    error_count => 2,
    when        => time,
  },
});

# prints: 2 errors encountered at 2010-10-20 19:23:42
print $thing->message;

DESCRIPTION

Throwable::X::WithMessage::Errf is an implementation of Throwable::X::WithMessage that uses String::Errf to format sprintf-like message strings. It adds a message_fmt attribute, initialized by the message argument. The value should be a String::Errf format string.

When the provided message method is called, it will fill in the format string with the hashref returned by calling the payload method, which must be implemented by the including class.

Throwable::X::WithMessage::Errf is a parameterized role. The default parameter lets you set a default format string or callback. The lazy parameter sets whether or not the message_fmt attribute is lazy. Setting it lazy will require that a default is provided.

AUTHOR

Ricardo Signes <rjbs@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2010 by Ricardo Signes.

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