/ 
Rinci-1.1.37
River stage one • 1 direct dependent • 1 total dependent
/ Rinci::result

NAME

Rinci::result - Function/method result metadata

VERSION

version 1.1.37

SPECIFICATION VERSION

1.1

INTRODUCTION

This document describes metadata for function/method result. This specification is part of Rinci. Please do a read up on it first, if you have not already done so.

SPECIFICATION

There are currently several properties being used:

Property: undo_data => ANY

(DEPRECATED) Explained in undo feature section in Rinci::function.

Properties: cmdline.*

Interpreted by Perinci::CmdLine. See its documentation for more detail.

Property: prev => ARRAY

Previous result in the "result stack" (analogous to stack trace). The result MUST be enveloped.

When reporting error that results from a call to another function, the original result can be set here, to preserve information. See Perinci::Sub::Util's wrapres() for a convenience function for this, and Perinci::CmdLine's way of displaying it.

Example:

sub f1 {
    ...
    if (error) { return [500, "Can't f1: blah"] }
    ...
}

sub f2 {
    ...
    my $res = f1(...);
    if ($res is error) { return [500, "Can't f2", undef, {prev=>$res}] }
    ...
}

sub f3 {
    ...
    my $res = f1(...);
    if ($res is error) { return [500, "Can't f3", undef, {prev=>$res}] }
}

FAQ

SEE ALSO

Rinci

AUTHOR

Steven Haryanto <stevenharyanto@gmail.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by Steven Haryanto.

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