Debian Codegraph @

upstream/debian-unstable/man3/Test2::Compare::Object.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::Object 3perl"
58 .TH Test2::Compare::Object 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::Object \- Representation of an object during deep
65 comparison.
66 .SH DESCRIPTION
67 .IX Header "DESCRIPTION"
68 This class lets you specify an expected object in a deep comparison. You can
69 check the fields/elements of the underlying reference, call methods to verify
70 results, and do meta checks for object type and ref type.
71 .SH METHODS
72 .IX Header "METHODS"
73 .ie n .IP "$class = $obj\->meta_class" 4
74 .el .IP "\f(CW$class\fR = \f(CW$obj\fR\->meta_class" 4
75 .IX Item "$class = $obj->meta_class"
76 The meta-class to be used when checking the object type. This is mainly listed
77 because it is useful to override for specialized object subclasses.
78 .Sp
79 This normally just returns Test2::Compare::Meta.
80 .ie n .IP "$class = $obj\->object_base" 4
81 .el .IP "\f(CW$class\fR = \f(CW$obj\fR\->object_base" 4
82 .IX Item "$class = $obj->object_base"
83 The base-class to be expected when checking the object type. This is mainly
84 listed because it is useful to override for specialized object subclasses.
85 .Sp
86 This normally just returns 'UNIVERSAL'.
87 .ie n .IP $obj\->add_prop(...) 4
88 .el .IP \f(CW$obj\fR\->add_prop(...) 4
89 .IX Item "$obj->add_prop(...)"
90 Add a meta-property to check, see Test2::Compare::Meta. This method
91 just delegates.
92 .ie n .IP $obj\->add_field(...) 4
93 .el .IP \f(CW$obj\fR\->add_field(...) 4
94 .IX Item "$obj->add_field(...)"
95 Add a hash-field to check, see Test2::Compare::Hash. This method
96 just delegates.
97 .ie n .IP $obj\->add_item(...) 4
98 .el .IP \f(CW$obj\fR\->add_item(...) 4
99 .IX Item "$obj->add_item(...)"
100 Add an array item to check, see Test2::Compare::Array. This method
101 just delegates.
102 .ie n .IP "$obj\->add_call($method, $check)" 4
103 .el .IP "\f(CW$obj\fR\->add_call($method, \f(CW$check\fR)" 4
104 .IX Item "$obj->add_call($method, $check)"
105 .PD 0
106 .ie n .IP "$obj\->add_call($method, $check, $name)" 4
107 .el .IP "\f(CW$obj\fR\->add_call($method, \f(CW$check\fR, \f(CW$name\fR)" 4
108 .IX Item "$obj->add_call($method, $check, $name)"
109 .ie n .IP "$obj\->add_call($method, $check, $name, $context)" 4
110 .el .IP "\f(CW$obj\fR\->add_call($method, \f(CW$check\fR, \f(CW$name\fR, \f(CW$context\fR)" 4
111 .IX Item "$obj->add_call($method, $check, $name, $context)"
112 .PD
113 Add a method call check. This will call the specified method on your object and
114 verify the result. \f(CW$method\fR may be a method name, an array ref, or a coderef.
115 .Sp
116 If it's an arrayref, the first element must be the method name, and
117 the rest are arguments that will be passed to it.
118 .Sp
119 In the case of a coderef it can be helpful to provide an alternate
120 name. When no name is provided the name is either \f(CW$method\fR or the
121 string '\e&CODE'.
122 .Sp
123 If \f(CW$context\fR is \f(CW\*(Aqlist\*(Aq\fR, the method will be invoked in list
124 context, and the result will be an arrayref.
125 .Sp
126 If \f(CW$context\fR is \f(CW\*(Aqhash\*(Aq\fR, the method will be invoked in list
127 context, and the result will be a hashref (this will warn if the
128 method returns an odd number of values).
129 .SH SOURCE
130 .IX Header "SOURCE"
131 The source code repository for Test2\-Suite can be found at
132 \&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR.
133 .SH MAINTAINERS
134 .IX Header "MAINTAINERS"
135 .IP "Chad Granum <[email protected]>" 4
136 .IX Item "Chad Granum <[email protected]>"
137 .SH AUTHORS
138 .IX Header "AUTHORS"
139 .PD 0
140 .IP "Chad Granum <[email protected]>" 4
141 .IX Item "Chad Granum <[email protected]>"
142 .PD
143 .SH COPYRIGHT
144 .IX Header "COPYRIGHT"
145 Copyright 2018 Chad Granum <[email protected]>.
146 .PP
147 This program is free software; you can redistribute it and/or
148 modify it under the same terms as Perl itself.
149 .PP
150 See \fIhttp://dev.perl.org/licenses/\fR