Data::Sah::CoerceCommon - Common stuffs for Data::Sah::Coerce and Data::Sah::CoerceJS
This document describes version 0.021 of Data::Sah::CoerceCommon (from Perl distribution Data-Sah-Coerce), released on 2017-03-14.
Usage:
get_coerce_rules(%args) -> [status, msg, result, meta]
Get coerce rules.
This routine lists coerce rule modules, filters out unwanted ones, loads the rest, filters out old (version < current) modules or ones that are not enabled by default. Finally the routine gets the rules out.
This common routine is used by Data::Sah compilers, as well as Data::Sah::Coerce and Data::Sah::CoerceJS.
This function is not exported.
Arguments ('*' denotes required arguments):
coerce_rules => array[str]
A specification of coercion rules to use (or avoid).
This setting is used to specify which coercion rules to use (or avoid) in a flexible way. Each element is a string, in the form of either NAME to mean specifically include a rule, or !NAME to exclude a rule, or REGEX or !REGEX to include or exclude a pattern. All NAME's that contains a non-alphanumeric, non-underscore character are assumed to be a REGEX pattern.
NAME
!NAME
REGEX
!REGEX
Without this setting, the default is to use all available coercion rules that have enabled_by_default set to 1 in their metadata.
enabled_by_default
To use all rules (even those that are not enabled by default):
['.']
To not use any rules:
['!.']
To use only rules named R1 and R2 and not any other rules (even enabled-by-default ones):
['!.', 'R1', 'R2']
To use only rules matching /^R/ and not any other rules (even enabled-by-default ones):
['!.', '^R']
To use the default rules plus R1 and R2:
['R1', 'R2']
To use the default rules plus rules matching /^R/:
['^R']
To use the default rules but not R1 and R2:
['!R1', '!R2']
To use the default rules but not rules matching /^R/:
['!^R']
coerce_to => str
Some Sah types, like date, can be represented in a choice of types in the target language. For example, in Perl you can store it as a floating number a.k.a. float(epoch), or as a DateTime object, or Time::Moment object. Storing in DateTime can be convenient for date manipulation but requires an overhead of loading the module and storing in a bulky format. The choice is yours to make, via this setting.
date
float(epoch)
compiler* => str
data_term* => str
type* => str
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
Please visit the project's homepage at https://metacpan.org/release/Data-Sah-Coerce.
Source repository is at https://github.com/perlancar/perl-Data-Sah-Coerce.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Data-Sah-Coerce
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, 2016 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.
To install Data::Sah::Coerce, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Data::Sah::Coerce
CPAN shell
perl -MCPAN -e shell install Data::Sah::Coerce
For more information on module installation, please visit the detailed CPAN module installation guide.