NAME
Sah::Schema::net::port - Network port number
VERSION
This document describes version 0.011 of Sah::Schema::net::port (from Perl distribution Sah-Schemas-Net), released on 2022-05-03.
SYNOPSIS
Sample data and validation results against this schema
""
# INVALID
1
# valid
80
# valid
65535
# valid
65536
# INVALID (Max is 2**16-1)
Using with Data::Sah
To check data against this schema (requires Data::Sah):
my
$validator
= gen_validator(
"net::port*"
);
say
$validator
->(
$data
) ?
"valid"
:
"INVALID!"
;
The above schema returns a boolean value (true if data is valid, false if otherwise). To return an error message string instead (empty string if data is valid, a non-empty error message otherwise):
my
$validator
= gen_validator(
"net::port"
, {
return_type
=>
'str_errmsg'
});
my
$errmsg
=
$validator
->(
$data
);
# a sample valid data
$data
= 65535;
my
$errmsg
=
$validator
->(
$data
);
# => ""
# a sample invalid data
$data
= 65536;
my
$errmsg
=
$validator
->(
$data
);
# => "Must be between 1 and 65535"
Often a schema has coercion rule or default value, so after validation the validated value is different. To return the validated (set-as-default, coerced, prefiltered) value:
my
$validator
= gen_validator(
"net::port"
, {
return_type
=>
'str_errmsg+val'
});
my
$res
=
$validator
->(
$data
);
# [$errmsg, $validated_val]
# a sample valid data
$data
= 65535;
my
$res
=
$validator
->(
$data
);
# => ["",65535]
# a sample invalid data
$data
= 65536;
my
$res
=
$validator
->(
$data
);
# => ["Must be between 1 and 65535",65536]
Data::Sah can also create validator that returns a hash of detaild error message. Data::Sah can even create validator that targets other language, like JavaScript, from the same schema. Other things Data::Sah can do: show source code for validator, generate a validator code with debug comments and/or log statements, generate human text from schema. See its documentation for more details.
Using with Params::Sah
To validate function parameters against this schema (requires Params::Sah):
sub
myfunc {
my
@args
=
@_
;
state
$validator
= gen_validator(
"net::port*"
);
$validator
->(\
@args
);
...
}
Using with Perinci::CmdLine::Lite
To specify schema in Rinci function metadata and use the metadata with Perinci::CmdLine (Perinci::CmdLine::Lite) to create a CLI:
# in lib/MyApp.pm
package
MyApp;
our
%SPEC
;
$SPEC
{myfunc} = {
v
=> 1.1,
summary
=>
'Routine to do blah ...'
,
args
=> {
arg1
=> {
summary
=>
'The blah blah argument'
,
schema
=> [
'net::port*'
],
},
...
},
};
sub
myfunc {
my
%args
=
@_
;
...
}
1;
# in myapp.pl
package
main;
Perinci::CmdLine::Any->new(
url
=>
'/MyApp/myfunc'
)->run;
# in command-line
% ./myapp.pl --help
myapp - Routine to
do
blah ...
...
% ./myapp.pl --version
% ./myapp.pl --arg1 ...
DESCRIPTION
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/Sah-Schemas-Net.
SOURCE
Source repository is at https://github.com/perlancar/perl-Sah-Schemas-Net.
AUTHOR
perlancar <perlancar@cpan.org>
CONTRIBUTING
To contribute, you can send patches by email/via RT, or send pull requests on GitHub.
Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:
% prove -l
If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.
COPYRIGHT AND LICENSE
This software is copyright (c) 2022, 2021, 2020, 2019, 2018, 2016 by perlancar <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.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Sah-Schemas-Net
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.