/ 
Data-Sah-Filter-0.025
River stage three • 26 direct dependents • 703 total dependents
/ Data::Sah::Filter::perl::Str::check

NAME

Data::Sah::Filter::perl::Str::check - Perform some checks

VERSION

This document describes version 0.025 of Data::Sah::Filter::perl::Str::check (from Perl distribution Data-Sah-Filter), released on 2024-07-17.

SYNOPSIS

Using in Sah schema's prefilters (or postfilters) clause

["str","prefilters",[["Str::check"]]]

Using with Data::Sah:

use Data::Sah qw(gen_validator);

my $schema = ["str","prefilters",[["Str::check"]]];
my $validator = gen_validator($schema);
if ($validator->($some_data)) { print 'Valid!' }

Using with Data::Sah:Filter directly:

use Data::Sah::Filter qw(gen_filter);

my $filter = gen_filter([["Str::check"]]);
# $errmsg will be empty/undef when filtering succeeds
my ($errmsg, $filtered_value) = $filter->($some_data);

Sample data and filtering results

12 # filtered with args {min_len=>3}, INVALID (Length of data must be at least 3), unchanged
12345 # filtered with args {min_len=>3}, valid, unchanged
123 # filtered with args {max_len=>3}, valid, unchanged
12345 # filtered with args {max_len=>3}, INVALID (Length of data must be at most 3), unchanged
123 # filtered with args {match=>"[abc]"}, INVALID (Data must match (?^:[abc])), unchanged
"a" # filtered with args {match=>"[abc]"}, valid, unchanged

DESCRIPTION

This is more or less a demo filter rule, to show how a filter rule can be used to perform some checks. The standard checks performed by this rule, however, are better done using standard Sah schema clauses like in, min_len, etc.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Data-Sah-Filter.

SOURCE

Source repository is at https://github.com/perlancar/perl-Data-Sah-Filter.

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) 2024, 2023, 2022, 2020 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=Data-Sah-Filter

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.