.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Perinci::Object::EnvResult 3pm"
.TH Perinci::Object::EnvResult 3pm "2022-10-13" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Perinci::Object::EnvResult \- Represent enveloped result
.SH "VERSION"
.IX Header "VERSION"
This document describes version 0.311 of Perinci::Object::EnvResult (from Perl distribution Perinci-Object), released on 2020\-01\-02.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& use Perinci::Object::EnvResult;
\& use Data::Dump; # for dd()
\&
\& my $envres = Perinci::Object::EnvResult\->new([200, "OK", [1, 2, 3]]);
\& dd $envres\->is_success, # 1
\&    $envres\->status,     # 200
\&    $envres\->message,    # "OK"
\&    $envres\->payload,    # [1, 2, 3]
\&    $envres\->meta,       # undef
\&    $envres\->as_struct;  # [200, "OK", [1, 2, 3]]
\&
\& # setting status, message, result, extra
\& $envres\->status(404);
\& $envres\->message(\*(AqNot found\*(Aq);
\& $envres\->payload(undef);
\& $envres\->meta({errno=>\-100});
\&
\& # shortcut: create a new OK result ([200, "OK"] or [200, "OK", $payload])
\& $envres = Perinci::Object::EnvResult\->new_ok();
\& $envres = Perinci::Object::EnvResult\->new_ok(42);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class provides an object-oriented interface for enveloped result (see
Rinci::function for more details).
.SH "METHODS"
.IX Header "METHODS"
.SS "new($res) => \s-1OBJECT\s0"
.IX Subsection "new($res) => OBJECT"
Create a new object from \f(CW$res\fR enveloped result array.
.ie n .SS "new_ok([ $actual_res ]) => \s-1OBJECT\s0"
.el .SS "new_ok([ \f(CW$actual_res\fP ]) => \s-1OBJECT\s0"
.IX Subsection "new_ok([ $actual_res ]) => OBJECT"
Shortcut for \f(CW\*(C`new([200,"OK",$actual_res])\*(C'\fR, or just \f(CW\*(C`new([200,"OK"])\*(C'\fR
if \f(CW$actual_res\fR is not specified.
.ie n .SS "$envres\->status"
.el .SS "\f(CW$envres\fP\->status"
.IX Subsection "$envres->status"
Get or set status (the 1st element).
.ie n .SS "$envres\->message"
.el .SS "\f(CW$envres\fP\->message"
.IX Subsection "$envres->message"
Get or set message (the 2nd element).
.ie n .SS "$envres\->payload"
.el .SS "\f(CW$envres\fP\->payload"
.IX Subsection "$envres->payload"
Get or set the actual payload (the 3rd element).
.ie n .SS "$envres\->meta"
.el .SS "\f(CW$envres\fP\->meta"
.IX Subsection "$envres->meta"
Get or set result metadata (the 4th element).
.ie n .SS "$envres\->as_struct"
.el .SS "\f(CW$envres\fP\->as_struct"
.IX Subsection "$envres->as_struct"
Return the represented data structure.
.ie n .SS "$envres\->is_success"
.el .SS "\f(CW$envres\fP\->is_success"
.IX Subsection "$envres->is_success"
True if status is between 200\-299.
.SH "HOMEPAGE"
.IX Header "HOMEPAGE"
Please visit the project's homepage at <https://metacpan.org/release/Perinci\-Object>.
.SH "SOURCE"
.IX Header "SOURCE"
Source repository is at <https://github.com/perlancar/perl\-Perinci\-Object>.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests on the bugtracker website <https://github.com/perlancar/perl\-Perinci\-Object/issues>
.PP
When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Perinci::Object
.SH "AUTHOR"
.IX Header "AUTHOR"
perlancar <perlancar@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2021, 2017, 2016, 2015, 2014, 2013, 2012, 2011 by perlancar@cpan.org.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.