| Perinci::Sub::Util::Args(3pm) | User Contributed Perl Documentation | Perinci::Sub::Util::Args(3pm) |
Perinci::Sub::Util::Args - Utility routines related to Rinci arguments
This document describes version 0.46 of Perinci::Sub::Util::Args (from Perl distribution Perinci-Sub-Util), released on 2017-01-31.
package MyPackage;
use Perinci::Sub::Util::Args qw(
args_by_tag
argnames_by_tag
func_args_by_tag
func_argnames_by_tag
call_with_its_args
);
our %SPEC;
my %func1_args;
$SPEC{myfunc1} = {
v => 1.1,
summary => 'My function one',
args => {
%func1_args = (
foo => {tags=>['t1', 't2']},
bar => {tags=>['t2', 't3']},
baz => {},
),
},
};
sub myfunc1 {
my %args = @_;
}
$SPEC{myfunc2} = {
v => 1.1,
summary => 'My function two',
args => {
%func1_args,
qux => {tags=>['t3']},
},
};
sub myfunc2 {
my %args = @_;
my $res = call_with_its_args('myfunc1', \%args);
}
Usage:
my %args = args_by_tag($meta, \%args0, $tag);
Will select only keypairs from %args0 arguments which have tag $tag. Examples:
my %args = args_by_tag($SPEC{myfunc1}, {foo=>1, bar=>2, baz=>3, qux=>4}, 't2'); # (foo=>1, bar=>2)
Usage:
my @arg_names = argnames_by_tag($meta, $tag);
Will select only argument names which have tag $tag.
Usage:
my %args = func_args_by_tag($func_name, \%args0, $tag);
Like "args_by_tag" except that instead of supplying Rinci function metadata, you supply a function name. Rinci metadata will be searched in %SPEC variable.
Usage:
my @argnames = func_argnames_by_tag($func_name, $tag);
Like "argnames_by_tag" except that instead of supplying Rinci function metadata, you supply a function name. Rinci metadata will be searched in %SPEC variable.
Usage:
my $res = call_with_its_args($func_name, \%args);
Call function with arguments taken from %args. Only arguments which the function declares it accepts will be passed.
Please visit the project's homepage at <https://metacpan.org/release/Perinci-Sub-Util>.
Source repository is at <https://github.com/sharyanto/perl-Perinci-Sub-Util>.
Please report any bugs or feature requests on the bugtracker website <https://rt.cpan.org/Public/Dist/Display.html?Name=Perinci-Sub-Util>
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.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2017 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.
| 2017-06-21 | perl v5.24.1 |