Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Test2::Compare::Ref.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::Ref 3pm"
61 .TH Test2::Compare::Ref 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::Ref \- Ref comparison
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 Used to compare two refs in a deep comparison.
71 .SH SYNOPSIS
72 .IX Header "SYNOPSIS"
73 .Vb 2
74 \& my $ref = {};
75 \& my $check = Test2::Compare::Ref\->new(input => $ref);
76 \&
77 \& # Passes
78 \& is( [$ref], [$check], "The array contains the exact ref we want" );
79 \&
80 \& # Fails, they both may be empty hashes, but we are looking for a specific
81 \& # reference.
82 \& is( [{}], [$check], "This will fail");
83 .Ve
84 .SH SOURCE
85 .IX Header "SOURCE"
86 The source code repository for Test2\-Suite can be found at
87 \&\fIhttps://github.com/Test\-More/test\-more/\fR.
88 .SH MAINTAINERS
89 .IX Header "MAINTAINERS"
90 .IP "Chad Granum <[email protected]>" 4
91 .IX Item "Chad Granum <[email protected]>"
92 .SH AUTHORS
93 .IX Header "AUTHORS"
94 .IP "Chad Granum <[email protected]>" 4
95 .IX Item "Chad Granum <[email protected]>"
96 .SH COPYRIGHT
97 .IX Header "COPYRIGHT"
98 Copyright Chad Granum <[email protected]>.
99 .PP
100 This program is free software; you can redistribute it and/or
101 modify it under the same terms as Perl itself.
102 .PP
103 See \fIhttp://dev.perl.org/licenses/\fR