Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Test2::Compare::Array.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Test2::Compare::Array 3pm"
61 .TH Test2::Compare::Array 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Test2::Compare::Array \- Internal representation of an array comparison.
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 This module is an internal representation of an array for comparison purposes.
71 .SH METHODS
72 .IX Header "METHODS"
73 .ie n .IP "$ref = $arr\->\fBinref()\fR" 4
74 .el .IP "\f(CW$ref\fR = \f(CW$arr\fR\->\fBinref()\fR" 4
75 .IX Item "$ref = $arr->inref()"
76 If the instance was constructed from an actual array, this will return the
77 reference to that array.
78 .ie n .IP "$bool = $arr\->ending" 4
79 .el .IP "\f(CW$bool\fR = \f(CW$arr\fR\->ending" 4
80 .IX Item "$bool = $arr->ending"
81 .PD 0
82 .ie n .IP $arr\->set_ending($bool) 4
83 .el .IP \f(CW$arr\fR\->set_ending($bool) 4
84 .IX Item "$arr->set_ending($bool)"
85 .PD
86 Set this to true if you would like to fail when the array being validated has
87 more items than the check. That is, if you check indexes 0\-3 but the array has
88 values for indexes 0\-4, it will fail and list that last item in the array as
89 unexpected. If set to false then it is assumed you do not care about extra
90 items.
91 .ie n .IP "$hashref = $arr\->\fBitems()\fR" 4
92 .el .IP "\f(CW$hashref\fR = \f(CW$arr\fR\->\fBitems()\fR" 4
93 .IX Item "$hashref = $arr->items()"
94 Returns the hashref of \f(CW\*(C`key => val\*(C'\fR pairs to be checked in the
95 array.
96 .ie n .IP $arr\->set_items($hashref) 4
97 .el .IP \f(CW$arr\fR\->set_items($hashref) 4
98 .IX Item "$arr->set_items($hashref)"
99 Accepts a hashref to permit indexes to be skipped if desired.
100 .Sp
101 \&\fBNote:\fR that there is no validation when using \f(CW\*(C`set_items\*(C'\fR, it is better to
102 use the \f(CW\*(C`add_item\*(C'\fR interface.
103 .ie n .IP "$arrayref = $arr\->\fBorder()\fR" 4
104 .el .IP "\f(CW$arrayref\fR = \f(CW$arr\fR\->\fBorder()\fR" 4
105 .IX Item "$arrayref = $arr->order()"
106 Returns an arrayref of all indexes that will be checked, in order.
107 .ie n .IP $arr\->set_order($arrayref) 4
108 .el .IP \f(CW$arr\fR\->set_order($arrayref) 4
109 .IX Item "$arr->set_order($arrayref)"
110 Sets the order in which indexes will be checked.
111 .Sp
112 \&\fBNote:\fR that there is no validation when using \f(CW\*(C`set_order\*(C'\fR, it is better to
113 use the \f(CW\*(C`add_item\*(C'\fR interface.
114 .ie n .IP "$name = $arr\->\fBname()\fR" 4
115 .el .IP "\f(CW$name\fR = \f(CW$arr\fR\->\fBname()\fR" 4
116 .IX Item "$name = $arr->name()"
117 Always returns the string \f(CW"<ARRAY>"\fR.
118 .ie n .IP "$bool = $arr\->verify(got => $got, exists => $bool)" 4
119 .el .IP "\f(CW$bool\fR = \f(CW$arr\fR\->verify(got => \f(CW$got\fR, exists => \f(CW$bool\fR)" 4
120 .IX Item "$bool = $arr->verify(got => $got, exists => $bool)"
121 Check if \f(CW$got\fR is an array reference or not.
122 .ie n .IP "$idx = $arr\->\fBtop_index()\fR" 4
123 .el .IP "\f(CW$idx\fR = \f(CW$arr\fR\->\fBtop_index()\fR" 4
124 .IX Item "$idx = $arr->top_index()"
125 Returns the topmost index which is checked. This will return undef if there
126 are no items, or \f(CW0\fR if there is only 1 item.
127 .ie n .IP $arr\->add_item($item) 4
128 .el .IP \f(CW$arr\fR\->add_item($item) 4
129 .IX Item "$arr->add_item($item)"
130 Push an item onto the list of values to be checked.
131 .ie n .IP "$arr\->add_item($idx => $item)" 4
132 .el .IP "\f(CW$arr\fR\->add_item($idx => \f(CW$item\fR)" 4
133 .IX Item "$arr->add_item($idx => $item)"
134 Add an item to the list of values to be checked at the specified index.
135 .ie n .IP "$arr\->add_filter(sub { ... })" 4
136 .el .IP "\f(CW$arr\fR\->add_filter(sub { ... })" 4
137 .IX Item "$arr->add_filter(sub { ... })"
138 Add a filter sub. The filter receives all remaining values of the array being
139 checked, and should return the values that should still be checked. The filter
140 will be run between the last item added and the next item added.
141 .ie n .IP "@deltas = $arr\->deltas(got => $got, convert => \e&convert, seen => \e%seen)" 4
142 .el .IP "\f(CW@deltas\fR = \f(CW$arr\fR\->deltas(got => \f(CW$got\fR, convert => \e&convert, seen => \e%seen)" 4
143 .IX Item "@deltas = $arr->deltas(got => $got, convert => &convert, seen => %seen)"
144 Find the differences between the expected array values and those in the \f(CW$got\fR
145 arrayref.
146 .SH SOURCE
147 .IX Header "SOURCE"
148 The source code repository for Test2\-Suite can be found at
149 \&\fIhttps://github.com/Test\-More/test\-more/\fR.
150 .SH MAINTAINERS
151 .IX Header "MAINTAINERS"
152 .IP "Chad Granum <[email protected]>" 4
153 .IX Item "Chad Granum <[email protected]>"
154 .SH AUTHORS
155 .IX Header "AUTHORS"
156 .IP "Chad Granum <[email protected]>" 4
157 .IX Item "Chad Granum <[email protected]>"
158 .SH COPYRIGHT
159 .IX Header "COPYRIGHT"
160 Copyright Chad Granum <[email protected]>.
161 .PP
162 This program is free software; you can redistribute it and/or
163 modify it under the same terms as Perl itself.
164 .PP
165 See \fIhttp://dev.perl.org/licenses/\fR