File Coverage

blib/lib/RPC/Lite/Error.pm

Criterion	Covered	Total	%
statement	6	13	46.1
branch	0	2	0.0
condition			n/a
subroutine	2	5	40.0
pod	3	3	100.0
total	11	23	47.8

package RPC::Lite::Error;

use strict;
use base qw(RPC::Lite::Response);

=pod

=head1 NAME

RPC::Lite::Error -- An error response from an RPC::Lite::Server.

=head1 DESCRIPTION

RPC::Lite::Error derives from RPC::Lite::Response, but instead of
having a valid object in the Result field, it has error information
in the Error field.

=head1 METHODS

=over 4

=item C

Takes the object to place in the Error field.

=cut

sub new
{
  my ($class, $data) = @_;

  my $self = bless {}, $class;
  $self->Error($data);

  return $self;
}

=pod

=item C

Returns undef on an RPC::Lite::Error object.

=cut

sub Result { return undef }

=pod

=item C

Returns the object encapsulated by the RPC::Lite::Error object.

=cut

sub Error  { $_[0]->{error} = $_[1] if @_>1; $_[0]->{error} }

=pod

=back

=head1 SEE ALSO

RPC::Lite::Response

=cut

1;