1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
NAME
Perinci::Object - Object-oriented interface for Rinci metadata
VERSION
This document describes version 0.311 of Perinci::Object (from Perl
distribution Perinci-Object), released on 2020-01-02.
SYNOPSIS
use Perinci::Object; # automatically exports risub(), rivar(), ripkg(),
# envres(), envresmulti(), envrestable(), riresmeta()
use Data::Dump; # for dd()
# OO interface to function metadata.
my $risub = risub {
v => 1.1,
summary => 'Calculate foo and bar',
"summary.alt.lang.id_ID" => 'Menghitung foo dan bar',
args => { a1 => { schema => 'int*' }, a2 => { schema => 'str' } },
features => { pure=>1 },
};
dd $risub->type, # "function"
$risub->v, # 1.1
$risub->arg('a1'), # { schema=>'int*' }
$risub->arg('a3'), # undef
$risub->feature('pure'), # 1
$risub->feature('foo'), # undef
$risub->langprop('summary'), # 'Calculate foo and bar'
$risub->langprop({lang=>'id_ID'}, 'summary'), # 'Menghitung foo dan bar'
# setting arg and property
$risub->arg('a3', 'array'); # will actually fail for 1.0 metadata
$risub->feature('foo', 2); # ditto
# OO interface to variable metadata
my $rivar = rivar { ... };
# OO interface to package metadata
my $ripkg = ripkg { ... };
# OO interface to enveloped result
my $envres = envres [200, "OK", [1, 2, 3]];
dd $envres->is_success, # 1
$envres->status, # 200
$envres->message, # "OK"
$envres->result, # [1, 2, 3]
$envres->meta; # undef
# setting status, message, result, extra
$envres->status(404);
$envres->message('Not found');
$envres->result(undef);
$envres->meta({errno=>-100});
# OO interface to function/method result metadata
my $riresmeta = riresmeta { ... };
# an example of using envresmulti()
sub myfunc {
...
my $envres = envresmulti();
# add result for each item
$envres->add_result(200, "OK", {item_id=>1, payload=>"a"});
$envres->add_result(202, "OK", {item_id=>2, note=>"blah", payload=>"b"});
$envres->add_result(404, "Not found", {item_id=>3});
...
# finally, return the result
return $envres->as_struct;
}
# an example of using envrestable()
sub myfunc {
...
my $envres = envrestable();
$envres->add_field('foo');
$envres->add_field('bar');
...
return $envres->as_struct;
}
DESCRIPTION
Rinci works using pure data structures, but sometimes it's convenient to
have an object-oriented interface (wrapper) for those data. This module
provides just that.
FUNCTIONS
rimeta $meta => OBJECT
Exported by default. A shortcut for
Perinci::Object::Metadata->new($meta).
risub $meta => OBJECT
Exported by default. A shortcut for
Perinci::Object::Function->new($meta).
rivar $meta => OBJECT
Exported by default. A shortcut for
Perinci::Object::Variable->new($meta).
ripkg $meta => OBJECT
Exported by default. A shortcut for
Perinci::Object::Package->new($meta).
envres $res => OBJECT
Exported by default. A shortcut for
Perinci::Object::EnvResult->new($res).
envresmulti $res => OBJECT
Exported by default. A shortcut for
Perinci::Object::EnvResultMulti->new($res).
envrestable $res => OBJECT
Exported by default. A shortcut for
Perinci::Object::EnvResultTable->new($res).
riresmeta $resmeta => OBJECT
Exported by default. A shortcut for Perinci::Object::ResMeta->new($res).
HOMEPAGE
Please visit the project's homepage at
<https://metacpan.org/release/Perinci-Object>.
SOURCE
Source repository is at
<https://github.com/perlancar/perl-Perinci-Object>.
BUGS
Please report any bugs or feature requests on the bugtracker website
<https://github.com/perlancar/perl-Perinci-Object/issues>
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.
SEE ALSO
Rinci
AUTHOR
perlancar <perlancar@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2021, 2017, 2016, 2015, 2014, 2013, 2012,
2011 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
|
