Debian Codegraph @

upstream/mageia-cauldron/man3pm/Test2::Tools::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::Tools::Ref 3pm"
61 .TH Test2::Tools::Ref 3pm 2025-06-24 "perl v5.42.0" "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::Tools::Ref \- Tools for validating references.
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 This module contains tools that allow you to verify that something is a ref. It
71 also has tools to check if two refs are the same exact ref, or different. None of
72 the functions in this module do deep comparisons.
73 .SH SYNOPSIS
74 .IX Header "SYNOPSIS"
75 .Vb 1
76 \& use Test2::Tools::Ref;
77 \&
78 \& # Ensure something is a ref.
79 \& ref_ok($ref);
80 \&
81 \& # Check that $ref is a HASH reference
82 \& ref_ok($ref, \*(AqHASH\*(Aq, \*(AqMust be a hash\*(Aq)
83 \&
84 \& ref_is($refa, $refb, "Same exact reference");
85 \&
86 \& ref_is_not($refa, $refb, "Not the same exact reference");
87 .Ve
88 .SH EXPORTS
89 .IX Header "EXPORTS"
90 All subs are exported by default.
91 .IP ref_ok($thing) 4
92 .IX Item "ref_ok($thing)"
93 .PD 0
94 .ie n .IP "ref_ok($thing, $type)" 4
95 .el .IP "ref_ok($thing, \f(CW$type\fR)" 4
96 .IX Item "ref_ok($thing, $type)"
97 .ie n .IP "ref_ok($thing, $type, $name)" 4
98 .el .IP "ref_ok($thing, \f(CW$type\fR, \f(CW$name\fR)" 4
99 .IX Item "ref_ok($thing, $type, $name)"
100 .PD
101 This checks that \f(CW$thing\fR is a reference. If \f(CW$type\fR is specified then it
102 will check that \f(CW$thing\fR is that type of reference.
103 .ie n .IP "ref_is($ref1, $ref2, $name)" 4
104 .el .IP "ref_is($ref1, \f(CW$ref2\fR, \f(CW$name\fR)" 4
105 .IX Item "ref_is($ref1, $ref2, $name)"
106 Verify that two references are the exact same reference.
107 .ie n .IP "ref_is_not($ref1, $ref2, $name)" 4
108 .el .IP "ref_is_not($ref1, \f(CW$ref2\fR, \f(CW$name\fR)" 4
109 .IX Item "ref_is_not($ref1, $ref2, $name)"
110 Verify that two references are not the exact same reference.
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/test\-more/\fR.
115 .SH MAINTAINERS
116 .IX Header "MAINTAINERS"
117 .IP "Chad Granum <[email protected]>" 4
118 .IX Item "Chad Granum <[email protected]>"
119 .SH AUTHORS
120 .IX Header "AUTHORS"
121 .IP "Chad Granum <[email protected]>" 4
122 .IX Item "Chad Granum <[email protected]>"
123 .SH COPYRIGHT
124 .IX Header "COPYRIGHT"
125 Copyright Chad Granum <[email protected]>.
126 .PP
127 This program is free software; you can redistribute it and/or
128 modify it under the same terms as Perl itself.
129 .PP
130 See \fIhttp://dev.perl.org/licenses/\fR