.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "Declare::Constraints::Simple::Library::Array 3pm" .TH Declare::Constraints::Simple::Library::Array 3pm "2018-03-31" "perl v5.26.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Declare::Constraints::Simple::Library::Array \- Array Constraints .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& # accept a list of pairs \& my $pairs_validation = IsArrayRef( HasArraySize(2,2) ); \& \& # integer => object pairs \& my $pairs = And( OnEvenElements(IsInt), \& OnOddElements(IsObject) ); \& \& # a three element array \& my $tri = And( HasArraySize(3,3), \& OnArrayElements(0, IsInt, \& 1, IsDefined, \& 2, IsClass) ); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module contains all constraints that can be applied to array references. .SH "CONSTRAINTS" .IX Header "CONSTRAINTS" .SS "HasArraySize([$min, [$max]])" .IX Subsection "HasArraySize([$min, [$max]])" With \f(CW$min\fR defaulting to 1. So a specification of .PP .Vb 1 \& my $profile = HasArraySize; .Ve .PP checks for at least one value. To force an exact size of the array, specify the same values for both: .PP .Vb 1 \& my $profile = HasArraySize(3, 3); .Ve .ie n .SS "OnArrayElements($key => $constraint, $key => $constraint, ...)" .el .SS "OnArrayElements($key => \f(CW$constraint\fP, \f(CW$key\fP => \f(CW$constraint\fP, ...)" .IX Subsection "OnArrayElements($key => $constraint, $key => $constraint, ...)" Applies the the \f(CW$constraint\fRs to the corresponding \f(CW$key\fRs if they are present. For required keys see \f(CW\*(C`HasArraySize\*(C'\fR. .SS "OnEvenElements($constraint)" .IX Subsection "OnEvenElements($constraint)" Runs the constraint on all even elements of an array. See also \&\f(CW\*(C`OnOddElements\*(C'\fR. .SS "OnOddElements($constraint)" .IX Subsection "OnOddElements($constraint)" Runs the constraint on all odd elements of an array. See also \&\f(CW\*(C`OnEvenElements\*(C'\fR. .SH "SEE ALSO" .IX Header "SEE ALSO" Declare::Constraints::Simple, Declare::Constraints::Simple::Library .SH "AUTHOR" .IX Header "AUTHOR" Robert 'phaylon' Sedlacek \f(CW\*(C`\*(C'\fR .SH "LICENSE AND COPYRIGHT" .IX Header "LICENSE AND COPYRIGHT" This module is free software, you can redistribute it and/or modify it under the same terms as perl itself.