.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Test2::Compare::Object 3pm"
.TH Test2::Compare::Object 3pm 2024-05-08 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Test2::Compare::Object \- Representation of an object during deep
comparison.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This class lets you specify an expected object in a deep comparison. You can
check the fields/elements of the underlying reference, call methods to verify
results, and do meta checks for object type and ref type.
.SH METHODS
.IX Header "METHODS"
.ie n .IP "$class = $obj\->meta_class" 4
.el .IP "\f(CW$class\fR = \f(CW$obj\fR\->meta_class" 4
.IX Item "$class = $obj->meta_class"
The meta-class to be used when checking the object type. This is mainly listed
because it is useful to override for specialized object subclasses.
.Sp
This normally just returns Test2::Compare::Meta.
.ie n .IP "$class = $obj\->object_base" 4
.el .IP "\f(CW$class\fR = \f(CW$obj\fR\->object_base" 4
.IX Item "$class = $obj->object_base"
The base-class to be expected when checking the object type. This is mainly
listed because it is useful to override for specialized object subclasses.
.Sp
This normally just returns 'UNIVERSAL'.
.ie n .IP $obj\->add_prop(...) 4
.el .IP \f(CW$obj\fR\->add_prop(...) 4
.IX Item "$obj->add_prop(...)"
Add a meta-property to check, see Test2::Compare::Meta. This method
just delegates.
.ie n .IP $obj\->add_field(...) 4
.el .IP \f(CW$obj\fR\->add_field(...) 4
.IX Item "$obj->add_field(...)"
Add a hash-field to check, see Test2::Compare::Hash. This method
just delegates.
.ie n .IP $obj\->add_item(...) 4
.el .IP \f(CW$obj\fR\->add_item(...) 4
.IX Item "$obj->add_item(...)"
Add an array item to check, see Test2::Compare::Array. This method
just delegates.
.ie n .IP "$obj\->add_call($method, $check)" 4
.el .IP "\f(CW$obj\fR\->add_call($method, \f(CW$check\fR)" 4
.IX Item "$obj->add_call($method, $check)"
.PD 0
.ie n .IP "$obj\->add_call($method, $check, $name)" 4
.el .IP "\f(CW$obj\fR\->add_call($method, \f(CW$check\fR, \f(CW$name\fR)" 4
.IX Item "$obj->add_call($method, $check, $name)"
.ie n .IP "$obj\->add_call($method, $check, $name, $context)" 4
.el .IP "\f(CW$obj\fR\->add_call($method, \f(CW$check\fR, \f(CW$name\fR, \f(CW$context\fR)" 4
.IX Item "$obj->add_call($method, $check, $name, $context)"
.PD
Add a method call check. This will call the specified method on your object and
verify the result. \f(CW$method\fR may be a method name, an array ref, or a coderef.
.Sp
If it's an arrayref, the first element must be the method name, and
the rest are arguments that will be passed to it.
.Sp
In the case of a coderef it can be helpful to provide an alternate
name. When no name is provided the name is either \f(CW$method\fR or the
string '\e&CODE'.
.Sp
If \f(CW$context\fR is \f(CW\*(Aqlist\*(Aq\fR, the method will be invoked in list
context, and the result will be an arrayref.
.Sp
If \f(CW$context\fR is \f(CW\*(Aqhash\*(Aq\fR, the method will be invoked in list
context, and the result will be a hashref (this will warn if the
method returns an odd number of values).
.SH SOURCE
.IX Header "SOURCE"
The source code repository for Test2\-Suite can be found at
\&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR.
.SH MAINTAINERS
.IX Header "MAINTAINERS"
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.SH AUTHORS
.IX Header "AUTHORS"
.PD 0
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.PD
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2018 Chad Granum <exodist@cpan.org>.
.PP
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.PP
See \fIhttp://dev.perl.org/licenses/\fR