Debian Codegraph @

upstream/debian-unstable/man3/Test2::Compare::Array.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "Test2::Compare::Array 3perl"
58 .TH Test2::Compare::Array 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 Test2::Compare::Array \- Internal representation of an array comparison.
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 This module is an internal representation of an array for comparison purposes.
68 .SH METHODS
69 .IX Header "METHODS"
70 .ie n .IP "$ref = $arr\->\fBinref()\fR" 4
71 .el .IP "\f(CW$ref\fR = \f(CW$arr\fR\->\fBinref()\fR" 4
72 .IX Item "$ref = $arr->inref()"
73 If the instance was constructed from an actual array, this will return the
74 reference to that array.
75 .ie n .IP "$bool = $arr\->ending" 4
76 .el .IP "\f(CW$bool\fR = \f(CW$arr\fR\->ending" 4
77 .IX Item "$bool = $arr->ending"
78 .PD 0
79 .ie n .IP $arr\->set_ending($bool) 4
80 .el .IP \f(CW$arr\fR\->set_ending($bool) 4
81 .IX Item "$arr->set_ending($bool)"
82 .PD
83 Set this to true if you would like to fail when the array being validated has
84 more items than the check. That is, if you check indexes 0\-3 but the array has
85 values for indexes 0\-4, it will fail and list that last item in the array as
86 unexpected. If set to false then it is assumed you do not care about extra
87 items.
88 .ie n .IP "$hashref = $arr\->\fBitems()\fR" 4
89 .el .IP "\f(CW$hashref\fR = \f(CW$arr\fR\->\fBitems()\fR" 4
90 .IX Item "$hashref = $arr->items()"
91 Returns the hashref of \f(CW\*(C`key => val\*(C'\fR pairs to be checked in the
92 array.
93 .ie n .IP $arr\->set_items($hashref) 4
94 .el .IP \f(CW$arr\fR\->set_items($hashref) 4
95 .IX Item "$arr->set_items($hashref)"
96 Accepts a hashref to permit indexes to be skipped if desired.
97 .Sp
98 \&\fBNote:\fR that there is no validation when using \f(CW\*(C`set_items\*(C'\fR, it is better to
99 use the \f(CW\*(C`add_item\*(C'\fR interface.
100 .ie n .IP "$arrayref = $arr\->\fBorder()\fR" 4
101 .el .IP "\f(CW$arrayref\fR = \f(CW$arr\fR\->\fBorder()\fR" 4
102 .IX Item "$arrayref = $arr->order()"
103 Returns an arrayref of all indexes that will be checked, in order.
104 .ie n .IP $arr\->set_order($arrayref) 4
105 .el .IP \f(CW$arr\fR\->set_order($arrayref) 4
106 .IX Item "$arr->set_order($arrayref)"
107 Sets the order in which indexes will be checked.
108 .Sp
109 \&\fBNote:\fR that there is no validation when using \f(CW\*(C`set_order\*(C'\fR, it is better to
110 use the \f(CW\*(C`add_item\*(C'\fR interface.
111 .ie n .IP "$name = $arr\->\fBname()\fR" 4
112 .el .IP "\f(CW$name\fR = \f(CW$arr\fR\->\fBname()\fR" 4
113 .IX Item "$name = $arr->name()"
114 Always returns the string \f(CW"<ARRAY>"\fR.
115 .ie n .IP "$bool = $arr\->verify(got => $got, exists => $bool)" 4
116 .el .IP "\f(CW$bool\fR = \f(CW$arr\fR\->verify(got => \f(CW$got\fR, exists => \f(CW$bool\fR)" 4
117 .IX Item "$bool = $arr->verify(got => $got, exists => $bool)"
118 Check if \f(CW$got\fR is an array reference or not.
119 .ie n .IP "$idx = $arr\->\fBtop_index()\fR" 4
120 .el .IP "\f(CW$idx\fR = \f(CW$arr\fR\->\fBtop_index()\fR" 4
121 .IX Item "$idx = $arr->top_index()"
122 Returns the topmost index which is checked. This will return undef if there
123 are no items, or \f(CW0\fR if there is only 1 item.
124 .ie n .IP $arr\->add_item($item) 4
125 .el .IP \f(CW$arr\fR\->add_item($item) 4
126 .IX Item "$arr->add_item($item)"
127 Push an item onto the list of values to be checked.
128 .ie n .IP "$arr\->add_item($idx => $item)" 4
129 .el .IP "\f(CW$arr\fR\->add_item($idx => \f(CW$item\fR)" 4
130 .IX Item "$arr->add_item($idx => $item)"
131 Add an item to the list of values to be checked at the specified index.
132 .ie n .IP "$arr\->add_filter(sub { ... })" 4
133 .el .IP "\f(CW$arr\fR\->add_filter(sub { ... })" 4
134 .IX Item "$arr->add_filter(sub { ... })"
135 Add a filter sub. The filter receives all remaining values of the array being
136 checked, and should return the values that should still be checked. The filter
137 will be run between the last item added and the next item added.
138 .ie n .IP "@deltas = $arr\->deltas(got => $got, convert => \e&convert, seen => \e%seen)" 4
139 .el .IP "\f(CW@deltas\fR = \f(CW$arr\fR\->deltas(got => \f(CW$got\fR, convert => \e&convert, seen => \e%seen)" 4
140 .IX Item "@deltas = $arr->deltas(got => $got, convert => &convert, seen => %seen)"
141 Find the differences between the expected array values and those in the \f(CW$got\fR
142 arrayref.
143 .SH SOURCE
144 .IX Header "SOURCE"
145 The source code repository for Test2\-Suite can be found at
146 \&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR.
147 .SH MAINTAINERS
148 .IX Header "MAINTAINERS"
149 .IP "Chad Granum <[email protected]>" 4
150 .IX Item "Chad Granum <[email protected]>"
151 .SH AUTHORS
152 .IX Header "AUTHORS"
153 .PD 0
154 .IP "Chad Granum <[email protected]>" 4
155 .IX Item "Chad Granum <[email protected]>"
156 .PD
157 .SH COPYRIGHT
158 .IX Header "COPYRIGHT"
159 Copyright 2018 Chad Granum <[email protected]>.
160 .PP
161 This program is free software; you can redistribute it and/or
162 modify it under the same terms as Perl itself.
163 .PP
164 See \fIhttp://dev.perl.org/licenses/\fR