Debian Codegraph @

upstream/mageia-cauldron/man3pm/Test2::Compare::Bag.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::Bag 3pm"
61 .TH Test2::Compare::Bag 3pm 2025-06-24 "perl v5.42.0" "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::Bag \- Internal representation of a bag comparison.
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 This module is an internal representation of a bag for comparison purposes.
71 .SH METHODS
72 .IX Header "METHODS"
73 .ie n .IP "$bool = $arr\->ending" 4
74 .el .IP "\f(CW$bool\fR = \f(CW$arr\fR\->ending" 4
75 .IX Item "$bool = $arr->ending"
76 .PD 0
77 .ie n .IP $arr\->set_ending($bool) 4
78 .el .IP \f(CW$arr\fR\->set_ending($bool) 4
79 .IX Item "$arr->set_ending($bool)"
80 .PD
81 Set this to true if you would like to fail when the array being validated has
82 more items than the check. That is, if you check for 4 items but the array has
83 5 values, it will fail and list that unmatched item in the array as
84 unexpected. If set to false then it is assumed you do not care about extra
85 items.
86 .ie n .IP "$arrayref = $arr\->\fBitems()\fR" 4
87 .el .IP "\f(CW$arrayref\fR = \f(CW$arr\fR\->\fBitems()\fR" 4
88 .IX Item "$arrayref = $arr->items()"
89 Returns the arrayref of values to be checked in the array.
90 .ie n .IP $arr\->set_items($arrayref) 4
91 .el .IP \f(CW$arr\fR\->set_items($arrayref) 4
92 .IX Item "$arr->set_items($arrayref)"
93 Accepts an arrayref.
94 .Sp
95 \&\fBNote:\fR that there is no validation when using \f(CW\*(C`set_items\*(C'\fR, it is better to
96 use the \f(CW\*(C`add_item\*(C'\fR interface.
97 .ie n .IP "$name = $arr\->\fBname()\fR" 4
98 .el .IP "\f(CW$name\fR = \f(CW$arr\fR\->\fBname()\fR" 4
99 .IX Item "$name = $arr->name()"
100 Always returns the string \f(CW"<BAG>"\fR.
101 .ie n .IP "$bool = $arr\->verify(got => $got, exists => $bool)" 4
102 .el .IP "\f(CW$bool\fR = \f(CW$arr\fR\->verify(got => \f(CW$got\fR, exists => \f(CW$bool\fR)" 4
103 .IX Item "$bool = $arr->verify(got => $got, exists => $bool)"
104 Check if \f(CW$got\fR is an array reference or not.
105 .ie n .IP $arr\->add_item($item) 4
106 .el .IP \f(CW$arr\fR\->add_item($item) 4
107 .IX Item "$arr->add_item($item)"
108 Push an item onto the list of values to be checked.
109 .ie n .IP "@deltas = $arr\->deltas(got => $got, convert => \e&convert, seen => \e%seen)" 4
110 .el .IP "\f(CW@deltas\fR = \f(CW$arr\fR\->deltas(got => \f(CW$got\fR, convert => \e&convert, seen => \e%seen)" 4
111 .IX Item "@deltas = $arr->deltas(got => $got, convert => &convert, seen => %seen)"
112 Find the differences between the expected bag values and those in the \f(CW$got\fR
113 arrayref.
114 .SH SOURCE
115 .IX Header "SOURCE"
116 The source code repository for Test2\-Suite can be found at
117 \&\fIhttps://github.com/Test\-More/test\-more/\fR.
118 .SH MAINTAINERS
119 .IX Header "MAINTAINERS"
120 .IP "Chad Granum <[email protected]>" 4
121 .IX Item "Chad Granum <[email protected]>"
122 .PD 0
123 .IP "Gianni Ceccarelli <[email protected]>" 4
124 .IX Item "Gianni Ceccarelli <[email protected]>"
125 .PD
126 .SH AUTHORS
127 .IX Header "AUTHORS"
128 .IP "Chad Granum <[email protected]>" 4
129 .IX Item "Chad Granum <[email protected]>"
130 .PD 0
131 .IP "Gianni Ceccarelli <[email protected]>" 4
132 .IX Item "Gianni Ceccarelli <[email protected]>"
133 .PD
134 .SH COPYRIGHT
135 .IX Header "COPYRIGHT"
136 Copyright Chad Granum <[email protected]>.
137 .PP
138 Copyright 2018 Gianni Ceccarelli <[email protected]>
139 .PP
140 This program is free software; you can redistribute it and/or
141 modify it under the same terms as Perl itself.
142 .PP
143 See \fIhttp://dev.perl.org/licenses/\fR