-
-
17 Jul 2021 12:25:09 UTC
- Distribution: Sah-Schemas-Path
- Module version: 0.016
- Source (raw)
- Browse (raw)
- Changes
- Homepage
- How to Contribute
- Repository
- Issues
- Testers (2047 / 0 / 2)
- Kwalitee
Bus factor: 1- % Coverage
- License: perl_5
- Perl: v5.10.1
- Activity
24 month- Tools
- Download (20.86KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
NAME
Sah::Schema::pathname - Filesystem path name
VERSION
This document describes version 0.016 of Sah::Schema::pathname (from Perl distribution Sah-Schemas-Path), 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("pathname*"); 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("pathname*"); $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 => ['pathname*'], }, ... }, }; 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 "foo" # valid "foo/bar" # valid
DESCRIPTION
This schema is basically string with some checks and prefilters. Why use this schema instead of plain ol' str? Mainly to give you the ability to change tilde to user's home directory, e.g.
~/foo
into/home/someuser/foo
. Normally this expansion is done by a Unix shell, but sometimes your program receives an unexpanded path, e.g. when you get it from some config file.See also more OS-specific schemas like
pathname::unix
, which adds some more checks (e.g. pathname cannot contain forward slash and each component cannot be longer than 255 characters) and preprocessing (e.g. stripping extraneous slashes likefoo//bar
intofoo/bar
.What's the difference between this schema and
filename
anddirname
? The default completion rule. This schema's completion by default includes files as well as directories.HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/Sah-Schemas-Path.
SOURCE
Source repository is at https://github.com/perlancar/perl-Sah-Schemas-Path.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Sah-Schemas-Path
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, 2020, 2019, 2018, 2016 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.
Module Install Instructions
To install Sah::Schemas::Path, copy and paste the appropriate command in to your terminal.
cpanm Sah::Schemas::Path
perl -MCPAN -e shell install Sah::Schemas::Path
For more information on module installation, please visit the detailed CPAN module installation guide.