NAME
Sah::Schema::unix::signal - Unix signal name (e.g. TERM or KILL) or number (9 or 15)
VERSION
This document describes version 0.021 of Sah::Schema::unix::signal (from Perl distribution Sah-Schemas-Unix), released on 2022-09-08.
SYNOPSIS
Sample data and validation results against this schema
"HUP" # valid
"INT" # valid
"QUIT" # valid
"ILL" # valid
"ABRT" # valid
"FPE" # valid
"KILL" # valid
"SEGV" # valid
"PIPE" # valid
"ALRM" # valid
"TERM" # valid
"USR1" # valid
"USR2" # valid
"CHLD" # valid
"CONT" # valid
"STOP" # valid
"TSTP" # valid
"TTIN" # valid
"TTOU" # valid
1 # valid
2 # valid
3 # valid
4 # valid
5 # valid
6 # valid
7 # valid
8 # valid
9 # valid
10 # valid
11 # valid
12 # valid
13 # valid
14 # valid
15 # valid
"" # INVALID
Using with Data::Sah
To check data against this schema (requires Data::Sah):
use Data::Sah qw(gen_validator);
my $validator = gen_validator("unix::signal*");
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("unix::signal", {return_type=>'str_errmsg'});
my $errmsg = $validator->($data);
# a sample valid data
$data = "ABRT";
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("unix::signal", {return_type=>'str_errmsg+val'});
my $res = $validator->($data); # [$errmsg, $validated_val]
# a sample valid data
$data = "ABRT";
my $res = $validator->($data); # => ["","ABRT"]
# 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.
Using with Params::Sah
To validate function parameters against this schema (requires Params::Sah):
use Params::Sah qw(gen_validator);
sub myfunc {
my @args = @_;
state $validator = gen_validator("unix::signal*");
$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 => ['unix::signal*'],
},
...
},
};
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 ...
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/Sah-Schemas-Unix.
SOURCE
Source repository is at https://github.com/perlancar/perl-Sah-Schemas-Unix.
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, 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.
COPYRIGHT AND LICENSE
This software is copyright (c) 2022, 2020, 2019 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-Unix
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.