Debian Codegraph @

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