Sah::Schema::posint - Positive integer (1, 2, ...)
This document describes version 0.077 of Sah::Schema::posint (from Perl distribution Sah-Schemas-Int), released on 2022-10-19.
1 # valid 0 # INVALID -1 # INVALID
To check data against this schema (requires Data::Sah):
use Data::Sah qw(gen_validator); my $validator = gen_validator("posint*"); say $validator->($data) ? "valid" : "INVALID!";
The above schema returns a boolean result (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("posint", {return_type=>'str_errmsg'}); my $errmsg = $validator->($data); # a sample valid data $data = undef; my $errmsg = $validator->($data); # => "" # a sample invalid data $data = undef; my $errmsg = $validator->($data); # => ""
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("posint", {return_type=>'str_errmsg+val'}); my $res = $validator->($data); # [$errmsg, $validated_val] # a sample valid data $data = undef; my $res = $validator->($data); # => ["",undef] # a sample invalid data $data = undef; my $res = $validator->($data); # => ["",undef]
Data::Sah can also create validator that returns a hash of detailed 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.
To validate function parameters against this schema (requires Params::Sah):
use Params::Sah qw(gen_validator); sub myfunc { my @args = @_; state $validator = gen_validator("posint*"); $validator->(\@args); ... }
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 => ['posint*'], }, ... }, }; 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 ...
To create a type constraint and type library from a schema:
package My::Types { use Type::Library -base; use Type::FromSah qw( sah2type ); __PACKAGE__->add_type( sah2type('$sch_name*', name=>'Posint') ); } use My::Types qw(Posint); Posint->assert_valid($data);
Zero is not included in this schema because zero is neither positive nor negative. See also uint for integers that start from 0.
uint
Please visit the project's homepage at https://metacpan.org/release/Sah-Schemas-Int.
Source repository is at https://github.com/perlancar/perl-Sah-Schemas-Int.
Types::XSD - Equivalent Type::Tiny constraints: PositiveInteger
Types::Numbers - Equivalent Type::Tiny constraints: PositiveInt
perlancar <perlancar@cpan.org>
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, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.
This software is copyright (c) 2022, 2021, 2020, 2018, 2017, 2016, 2014 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.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Sah-Schemas-Int
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.
To install Sah::Schemas::Int, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Sah::Schemas::Int
CPAN shell
perl -MCPAN -e shell install Sah::Schemas::Int
For more information on module installation, please visit the detailed CPAN module installation guide.