NAME
Sah::Schema::uint_range - Unsigned integer range (sequence of uints/simple ranges), e.g. 1 / 5-7 / 1,10 / 1,5-7,10
VERSION
This document describes version 0.004 of Sah::Schema::uint_range (from Perl distribution Sah-Schemas-IntRange), released on 2021-07-17.
SYNOPSIS
To check data against this schema (requires Data::Sah):
use Data::Sah qw(gen_validator);
my $validator = gen_validator("uint_range*");
say $validator->($data) ? "valid" : "INVALID!";
# Data::Sah can also create validator that returns nice error message string
# and/or coerced value. Data::Sah can even create validator that targets other
# language, like JavaScript. All from the same schema. See its documentation
# for more details.
To validate function parameters against this schema (requires Params::Sah):
use Params::Sah qw(gen_validator);
sub myfunc {
my @args = @_;
state $validator = gen_validator("uint_range*");
$validator->(\@args);
...
}
To specify schema in Rinci function metadata and use the metadata with Perinci::CmdLine 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 => ['uint_range*'],
},
...
},
};
sub myfunc {
my %args = @_;
...
}
1;
# in myapp.pl
package main;
use Perinci::CmdLine::Any;
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 ...
Sample data:
"" # INVALID (Empty string)
1 # valid
-2 # INVALID (Negative)
1.5 # INVALID (Float)
"1-1" # valid
"1-2" # valid
"1 - 2" # valid
"0-100" # valid
"-1-2" # INVALID (Negative)
"-10--1" # INVALID (Negative)
"1-" # INVALID (Missing end value)
"1-1.5" # INVALID
"9-2" # INVALID (start value cannot be larger than end value)
"1-2-3" # INVALID (Invalid simple int range syntax)
" 1-2 " # INVALID (Leading and trailing whitespace is currently not allowed)
"1,2" # valid
"1 , 2" # valid
"1,2,-3,4" # INVALID (Negative)
"1,2,-3,4.5" # INVALID (Float)
"1," # INVALID (Dangling comma is currently not allowed)
"1,,2" # INVALID (Multiple commas are currently not allowed)
"1,2-5" # valid
"-1,-2-5,7,9-9" # INVALID (Negative)
"1,9-2" # INVALID (start value cannot be larger than end value)
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/Sah-Schemas-IntRange.
SOURCE
Source repository is at https://github.com/perlancar/perl-Sah-Schemas-IntRange.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Sah-Schemas-IntRange
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.
AUTHOR
perlancar <perlancar@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2021 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.