Debian Codegraph @

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